5 Oracle Managed File Transfer Custom WLST Commands

Bulk deploys multiple source, transfer, or target artifacts. In the event of an unsupported operation, the command returns a WLSTException.

bulkDeployArtifact(artifact_type, artifact_names, comment)

The following example deploys two SOURCE artifacts and provides a comment.

bulkDeployArtifact('SOURCE', 'order-file-src,chk-inv-src', 'retrieves new purchase orders, checks inventory')

The following example deploys all TRANSFER artifacts and provides a comment.

bulkDeployArtifact('TRANSFER', '*', 'deploying all transfers')

Deletes a source, transfer, or target artifact. In the event of an unsupported operation, the command returns a WLSTException.

deleteArtifact(artifact_type, artifact_name)

delAF(artifact_type, artifact_name)

The following example deletes a SOURCE artifact called order-file-src.

deleteArtifact('SOURCE', 'order-file-src')

Deletes an undeployed source, transfer, or target artifact. In the event of an unsupported operation, the command returns a WLSTException.

deleteArtifactDeployment(artifact_type, artifact_name, label)

delDepAF(artifact_type, artifact_name, label)

The following example deletes a SOURCE artifact called order-file-src with the label soa_mft-2012-12-07 22:24:09.383.

deleteArtifactDeployment('SOURCE', 'order-file-src', 'soa_mft-2012-12-07 22:24:09.383')

Deploys a source, transfer, or target artifact. In the event of an unsupported operation, the command returns a WLSTException.

deployArtifact(artifact_type, artifact_name, comment)

depAF(artifact_type, artifact_name, comment)

The following example deploys a SOURCE artifact called order-file-src and provides a comment about the artifact.

deployArtifact('SOURCE', 'order-file-src', 'retrieves new purchase orders')

Disables a deployed and previously enabled source, transfer, or target artifact. In the event of an unsupported operation, the command returns a WLSTException.

disableArtifact(artifact_type, artifact_name, comment)

disAF(artifact_type, artifact_name, comment)

The following example disables a SOURCE artifact called order-file-src and provides a comment about the reason.

disableArtifact('SOURCE', 'order-file-src', 'order server being upgraded')

Enables a deployed and previously disabled source, transfer, or target artifact. In the event of an unsupported operation, the command returns a WLSTException.

enableArtifact(artifact_type, artifact_name, comment)

enAF(artifact_type, artifact_name, comment)

The following example enables a SOURCE artifact called order-file-src and provides a comment about the reason.

enableArtifact('SOURCE', 'order-file-src', 'order server upgrade complete')

Exports a deployed source, transfer, or target artifact to a ZIP file. In the event of an unsupported operation, the command returns a WLSTException.

exportDeployedArtifact(artifact_type, artifact_name, label, archive_file_path)

expDepAF(artifact_type, artifact_name, label, archive_file_path)

The following example exports a SOURCE artifact called order-file-src with the label soa_mft-2012-12-07 22:24:09.383 to /export/order-file-src.zip.

exportDeployedArtifact('SOURCE', 'order-file-src', 'soa_mft-2012-12-07 22:24:09.383', '/export/order-file-src.zip')

Checks whether a source, transfer, or target artifact exists in the MDS (Metadata Store) and returns TRUE or FALSE. In the event of an unsupported operation, the command returns a WLSTException.

isArtifactInMDS(artifact_type, artifact_name)

isAFinMDS(artifact_type, artifact_name)

The following example checks whether a SOURCE artifact called order-file-src exists in the MDS.

isArtifactInMDS('SOURCE', 'order-file-src')

Undeploys a source, transfer, or target artifact without deleting it from the configuration. In the event of an unsupported operation, the command returns a WLSTException.

undeployArtifact(artifact_type, artifact_name, comment)

undepAF(artifact_type, artifact_name, comment)

The following example undeploys a SOURCE artifact called order-file-src and provides a comment about the reason.

undeployArtifact('SOURCE', 'order-file-src', 'upgrading artifact')

Exports the entire MFT configuration, excluding passwords, to a ZIP file. In the event of an unsupported operation, the command returns a WLSTException.

exportMftMetadata(archive_file_path)

expMD(archive_file_path)

The following example exports the MFT configuration to /export/mft-config-dec-2012.zip.

exportMftMetadata('/export/mft-config-dec-2012.zip')

Exports a transfer artifact and related metadata to a ZIP file. In the event of an unsupported operation, the command returns a WLSTException.

exportTransferMetadata(archive_file_path, transfer_name)

expXfrMD(archive_file_path, transfer_name)

The following example exports a transfer artifact named order-xfr and its metadata to /export/order-xfr.zip.

exportTransferMetadata('/export/order-xfr.zip', 'order-xfr')

Imports a previously exported MFT configuration from a ZIP file. In the event of an unsupported operation, the command returns a WLSTException.

importMftMetadata(archive_file_path)

impMD(archive_file_path)

The following example imports the MFT configuration from /export/mft-config-dec-2012.zip.

importMftMetadata('/export/mft-config-dec-2012.zip')

Resets the MFT configuration, deleting all artifacts and resetting all administrative settings to their defaults, while optionally preserving user preferences. In the event of an unsupported operation, the command returns a WLSTException.

resetMetadata(preserve_preferences)

resMD(preserve_preferences)

The following example resets the MFT configuration but preserves user preferences.

resetMetadata('TRUE')

Deletes a key alias from the MFT keystore. In the event of an unsupported operation, the command returns a WLSTException.

deleteCSFKey(key_format, key_type, alias)

delKey(key_format, key_type, alias)

The following example deletes a PRIVATE SSH key with the alias my-alias.

deleteCSFKey('SSH', 'PRIVATE', 'my-alias')

Exports keys from the MFT keystore to a key file. In the event of an unsupported operation, the command returns a WLSTException.

exportCSFKey(key_format, key_type, key_file_path)

expKey(key_format, key_type, key_file_path)

The following example exports PRIVATE SSH keys to the file /export/ssh/my_private_keys.ppk.

exportCSFKey('SSH', 'PRIVATE', '/export/ssh/my_private_keys.ppk')

Generates keys and saves them to one or more key files. The key type is RSA and the key size is 1024 bits. In the event of an unsupported operation, the command returns a WLSTException.

generateKeys(key_format, password, key_file_path)

genKeys(key_format, password, key_file_path)

The following example exports SSH keys without password protection to the file /export/ssh/ssh-pvt-keys.ppk.

generateKeys('SSH', '','/export/ssh/ssh-pvt-keys.ppk')

The following example exports PGP keys with password protection to the directory /export/pgp.

generateKeys('PGP', 'P@s$W0rd','/export/pgp')

Imports a key to the MFT keystore from a key file and creates an alias. In the event of an unsupported operation, the command returns a WLSTException.

importCSFKey(key_format, key_type, alias, key_file_path)

impKey(key_format, key_type, alias, key_file_path)

The following example imports a PRIVATE SSH key with the alias my-alias from the file /export/ssh/my_private_keys.ppk.

importCSFKey('SSH', 'PRIVATE', 'my-alias', '/export/ssh/my_private_keys.ppk')

The following example imports a PUBLIC PGP key with the alias mftpgppub from the file /export/pgp/pub.asc.

importCSFKey('PGP', 'PUBLIC', 'mftpgppub', '/export/pgp/pub.asc')

The following example imports a PRIVATE PGP key with the alias mftpgppri from the file /export/pgp/secret.asc.

importCSFKey('PGP', 'PRIVATE', 'mftpgppri', '/export/pgp/secret.asc')

Lists key aliases in the MFT keystore. In the event of an unsupported operation, the command returns a WLSTException.

listCSFKeyAliases(key_format, key_type, alias)

lsKeyAliases(key_format, key_type, alias)

The following example lists PRIVATE SSH keys.

listCSFKeyAliases('SSH', 'PRIVATE')

Deletes a key alias from the MFT keystore and generates a new key file. In the event of an unsupported operation, the command returns a WLSTException.

updateCSFKey(key_format, key_type, alias, key_file_path)

updKey(key_format, key_type, alias, key_file_path)

The following example deletes a PRIVATE SSH key with the alias my-alias and generates the key file /export/ssh/my-private-key.ppk.

updateCSFKey('SSH', 'PRIVATE', 'my-alias', '/export/ssh/my-private-key.ppk')

Returns the deployment history of a source artifact. In the event of an unsupported operation, the command returns a WLSTException.

getSourceDeploymentHistory(source_name)

getSrcDH(source_name)

The following example returns the deployment history of a source artifact named order-file-src.

getSourceDeploymentHistory('order-file-src')

Returns the deployment history of a target artifact. In the event of an unsupported operation, the command returns a WLSTException.

getTargetDeploymentHistory(target_name)

getTrgtDH(target_name)

The following example returns the deployment history of a target artifact named order-file-tgt.

getTargetDeploymentHistory('order-file-tgt')

Returns the deployment history of a transfer artifact. In the event of an unsupported operation, the command returns a WLSTException.

getTransferDeploymentHistory(transfer_name)

getXfrDH(transfer_name)

The following example returns the deployment history of a transfer artifact named order-xfr.

getTransferDeploymentHistory('order-xfr')

Returns information about a transfer artifact. In the event of an unsupported operation, the command returns a WLSTException.

getTransferInfo(transfer_name, label)

getXfrInfo(transfer_name, label)

The following example returns information about a transfer artifact named order-xfr with the label soa_mft-2012-12-07 22:28:17.392.

getTransferInfo('order-xfr', 'soa_mft-2013-09-26 22:28:17.392')
ID                                        | NAME          | LABEL
xfer_521a6788-4e24-4822-bb03-43a4a8eaa8ce | ftp-file-xfer | soa_mft-2013-09-26 16:00:09.803

Pauses an in-progress transfer. In the event of an unsupported operation, the command returns a WLSTException.

pauseTransfer(instance_id, comment)

pauseXfr(instance_id, comment)

The following example pauses a transfer with the target instance ID 240C93AD-5401-483B-8182-274FA0705DF1 and provides a reason.

pauseTransfer('240C93AD-5401-483B-8182-274FA0705DF1', 'resume when less network traffic')

Resubmits a transfer. You can resubmit a successful or failed transfer. In the event of an unsupported operation, the command returns a WLSTException.

resubmit(resubmit_type, instance_ids, comment)

resub(resubmit_type, instance_ids, comment)

The following example resubmits a SOURCE with the instance ID 3D48B12B-295A-4F52-A8EE-BD1CC1A20246 and provides a reason.

resubmit('SOURCE', '3D48B12B-295A-4F52-A8EE-BD1CC1A20246', 'trying again')

Resumes a paused transfer. In the event of an unsupported operation, the command returns a WLSTException.

resumeTransfer(instance_id, comment)

resXfr(instance_id, comment)

The following example resumes a transfer with the target instance ID 240C93AD-5401-483B-8182-274FA0705DF1 and provides a reason.

resumeTransfer('240C93AD-5401-483B-8182-274FA0705DF1', 'less network traffic now')

Assigns the specified directory to the user as home directory where that user is located on login to embedded servers.

configureHomeDir(directory_path, user_name)

The following example assigns directory dir1 as the home directory for a user named "user1".

configureHomeDir("/dir1","user1")

Grant permission to an embedded server directory. Users and groups can be assigned a set of permissions to an existing directory on an embedded server.

grantPermissionToDirectory(directory_path, principal_name, principal_type, permissions, server_type, include_subfolder)

The following example assigns read, write, list and delete permissions to the directory /orders (and sub-directories) for the user "weblogic" on an FTP server:

grantPermissionToDirectory("/orders","weblogic","USER", "READ, WRITE, LIST, DELETE","FTP",true) 

List all permissions available for a given principal and server type. The server type can be FTP or SFTP.

listAllPermissions(principal_name,server_type)

The following example lists all permissions for the principal named "weblogic" on an FTP server.

listAllPermissions("weblogic","FTP"

Revoke a set of permissions from an embedded server directory.

revokePermissionForDirectory(directory_path, principal_name, principal_type, permissions, server_type, include_subfolder)

The following example revokes read, write, list and delete permissions from the directory /orders (and sub-directories) for the user "weblogic" on an FTP server:

grantPermissionToDirectory("/orders","weblogic","USER", "READ, WRITE, LIST, DELETE","FTP",true) 

Starts an embedded FTP, FTPS (FTP over SSL), or sFTP (SSH-FTP) server that was stopped. In the event of an unsupported operation, the command returns a WLSTException.

startEmbeddedServer(server_type)

startES(server_type)

The following example starts the embedded FTP server.

startEmbeddedServer('FTP')

Stops an embedded FTP, FTPS (FTP over SSL), or sFTP (SSH-FTP) server that is running. In the event of an unsupported operation, the command returns a WLSTException.

stopEmbeddedServer(server_type)

stopES(server_type)

The following example stops the embedded FTP server.

stopEmbeddedServer('FTP')

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. In the event of an unsupported operation, the command returns a WLSTException.

updatePorts(server_instance, service, port)

updPorts(server_instance, service, port)

The following example updates the port of the embedded FTP server.

updatePorts('mft_server1', 'FTP', 7021)

Creates callouts based on an XML file that defines them. In the event of an unsupported operation, the command returns a WLSTException.

See Processing Transfers with Custom Callouts in Using Oracle Managed File Transfer for callout instructions and examples.

createCallouts(def_file_path)

crtCalls(def_file_path)

The following example creates callouts based on a definition file named /tmp/CalloutDefn.xml.

createCallouts('/tmp/CalloutDefn.xml')

Deletes a callout. In the event of an unsupported operation, the command returns a WLSTException.

deleteCallout(callout_name)

delCalls(callout_name)

The following example deletes a callout named NotifyTransferComplete.

deleteCallout('NotifyTransferComplete')

Lists callouts. In the event of an unsupported operation, the command returns a WLSTException.

listCallouts()

lsCalls()

The following example lists callouts.

listCallouts()

Updates callouts with the same names based on an XML file that defines them. In the event of an unsupported operation, the command returns a WLSTException.

updateCallouts(def_file_path)

updCalls(def_file_path)

The following example updates callouts based on a definition file named /tmp/CalloutDefn.xml.

updateCallouts('/tmp/CalloutDefn.xml')

Adds a contact to a specific event notification. In the event of an unsupported operation, the command returns a WLSTException.

addContactToNotification(event, contact_type, value)

addContNote(event, contact_type, value)

The following example adds EMAIL contact [email protected] to RUNTIME_ERROR_EVENT notifications.

addContactToNotification('RUNTIME_ERROR_EVENT', 'EMAIL', '[email protected]')

Creates a contact for event notifications. In the event of an unsupported operation, the command returns a WLSTException.

See Configuring an Email Driver for Notifications in Using Oracle Managed File Transfer for information on how to configure an email driver. See Configuring an SMS Driver for Notifications in Using Oracle Managed File Transfer for information on how to configure an SMS driver.

createContact(contact_type, value)

crtCont(contact_type, value)

The following example creates a contact based on the email address [email protected].

createContact('EMAIL', '[email protected]')

Deletes a contact. In the event of an unsupported operation, the command returns a WLSTException.

deleteContact(contact_type, value)

delCont(contact_type, value)

The following example deletes a contact based on the email address [email protected].

deleteContact('EMAIL', '[email protected]')

Lists contacts. In the event of an unsupported operation, the command returns a WLSTException.

listContacts(contact_type)

lsConts(contact_type)

The following example lists email contacts.

listContacts('EMAIL')

Removes a contact from a specific event notification. In the event of an unsupported operation, the command returns a WLSTException.

When you remove the last contact from an event, the event is disabled. However, the reverse is not true. When you add the first contact to an event, it is not enabled automatically. Enable an event using the updateEvent command.

removeContactFromNotification(event, contact_type, value)

remContNote(event, contact_type, value)

The following example removes EMAIL contact [email protected] from RUNTIME_ERROR_EVENT notifications.

removeContactFromNotification('RUNTIME_ERROR_EVENT', 'EMAIL', '[email protected]')

Enables or disables a specific event notification. Event notifications are disabled by default. In the event of an unsupported operation, the command returns a WLSTException.

updateEvent(event, enabled)

updEvt(event, enabled)

The following example disables DELETE_ARTIFACT_EVENT notifications.

updateEvent('DELETE_ARTIFACT_EVENT', 'FALSE')

Archives runtime instances based on specified criteria. Optionally archives file system data. In the event of an unsupported operation, the command returns a WLSTException.

Before you can run this command, you must create an MFT archive directory on the database server using the following SQL commands:

CREATE DIRECTORY MFT_DIR AS path;
GRANT READ, WRITE ON DIRECTORY MFT_DIR TO MFT_STB;

For more information about the database and the schema owner (MFT_STB), see Installing and Configuring Managed File Transfer.

archiveInstanceData(arguments)

arcData(arguments)

The following example runs in test mode (does not archive anything) and in the background (does not block WLST commands while running) for all instances with status COMPLETED, and provides statistics such as how many instances or payloads would be archived.

archiveInstanceData()

Here is an example of the output:

Total no. of instances to be archived: 105.
Total no. of payloads to be archived: 105.
Nothing has been archived as test mode was TRUE.
To archive these records, run the same command
by passing batch id 546781 and test mode as FALSE.

The following example runs in test mode and in the background for instances before March 31st, 2013 with status COMPLETED, and provides archive statistics. Note that when the startDate argument is omitted, the endDate argument must be explicitly labeled.

archiveInstanceData(endDate='31-03-2013 00:00:00:00')

The following example archives instances from February 1st, 2013 to March 31st, 2013 with status COMPLETED to the file mft.dmp, and provides archive statistics. Note that when the startDate and endDate arguments are both included, labels may be omitted.

archiveInstanceData(archiveFileName='mft.dmp','01-02-2013 00:00:00:00', '31-03-2013 00:00:00:00', testMode='FALSE')

The following example archives instances from February 1st, 2013 to March 31st, 2013 with status ACTIVE or FAILED to the file mft.dmp, and provides archive statistics. Because runInSync='TRUE' is specified, the archive occurs immediately and blocks further WLST commands until completion. Because runFSArchive='TRUE' is specified, file system data is also archived.

archiveInstanceData(archiveFileName='mft.dmp','01-02-2013 00:00:00:00', '31-03-2013 00:00:00:00', testMode='FALSE', status='A,F',
runInSync='TRUE', fsArchiveFolderPath='2013-01-02-MftArchive')

The following example runs a previously tested or failed archive with batch ID 546781 from the point of failure.

archiveInstanceData(archiveFileName='mft2.dmp',batchId='546781', testMode='FALSE')

Restores previously archived runtime instances. In the event of an unsupported operation, the command returns a WLSTException.

restoreInstanceData(arguments)

resData(arguments)

The following example restores runtime instance data previously archived by an archiveInstanceData command. The corresponding payload archive is restored from /tmp/mft/546781.zip. This command runs in the background.

restoreInstanceData(archiveFilePath="mft_runtime_archive.dmp", fileNamePrefix="546781", fsFolderPath="/tmp/mft")

Archives file system data corresponding to runtime instance data based on specified criteria. In the event of an unsupported operation, the command returns a WLSTException.

archivePayloads(arguments)

arcPLs(arguments)

For details about how to set MBean properties using Enterprise Manager, see Setting System MBean Properties for MFT WLST Commands.

The following example archives file system data corresponding to the runtime instance data previously archived by an archiveInstanceData command with the batch ID 546781. The archive is saved to /tmp/mft/546781.zip and runs immediately.

archivePayloads(batchId='546781',archivePath='/tmp/mft',runInSync='TRUE')

Restores previously archived file system data. In the event of an unsupported operation, the command returns a WLSTException.

restorePayloadsByName(arguments)

resPLbyN(arguments)

For details about how to set MBean properties using Enterprise Manager, see Setting System MBean Properties for MFT WLST Commands.

The following example restores file system data corresponding to the runtime instance data previously archived by an archivePayloads command with the batch ID 546781. The archive is restored from /tmp/mft/546781.zip and runs immediately.

restorePayloadsByName(fileNames='546781',folderPath='/tmp/mft',runInSync='TRUE')

Restores previously archived file system data. In the event of an unsupported operation, the command returns a WLSTException.

restorePayloadsByPrefix(arguments)

resPLbyP(arguments)

For details about how to set MBean properties using Enterprise Manager, see Setting System MBean Properties for MFT WLST Commands.

The following example restores file system data corresponding to the runtime instance data previously archived by an archivePayloads command with the batch ID 546781. The archive is restored from /tmp/mft/546781.zip and runs immediately.

restorePayloadsByPrefix(fileNamePrefix='546781',folderPath='/tmp/mft',runInSync='TRUE')

Purges runtime instances based on specified criteria. Optionally purges file system data. In the event of an unsupported operation, the command returns a WLSTException.

purgeInstanceData(optional_arguments)

prgData(optional_arguments)

The following example runs in test mode (does not purge anything) and in the background (does not block WLST commands while running) for all instances with status COMPLETED, and provides statistics such as how many instances or payloads would be purged.

purgeInstanceData()

Here is an example of the output:

Total no. of purgeable instances: 105.
Total no. of purgeable payloads: 105.
Nothing has been purged as test_mode was TRUE.
To purge these records, run the same command
by passing batchId 546781 and test mode as FALSE.

The following example runs in test mode and in the background for instances before March 31st, 2013 with status COMPLETED, and provides purge statistics. Note that when the startDate argument is omitted, the endDate argument must be explicitly labeled.

purgeInstanceData(endDate='31-03-2013 00:00:00:00')

The following example purges instances from February 1st, 2013 to March 31st, 2013 with status COMPLETED, and provides purge statistics. Note that when the startDate and endDate arguments are both included, labels may be omitted.

purgeInstanceData('01-02-2013 00:00:00:00', '31-03-2013 00:00:00:00', testMode='FALSE')

The following example purges instances from February 1st, 2013 to March 31st, 2013 with status ACTIVE or FAILED, and provides purge statistics. Because runInSync='TRUE' is specified, the purge occurs immediately and blocks further WLST commands until completion. Because runPayloadPurge='TRUE' is specified, file system data is also purged.

purgeInstanceData('01-02-2013 00:00:00:00', '31-03-2013 00:00:00:00', testMode='FALSE', status='A,F', runInSync='TRUE',
runPayloadPurge='TRUE')

The following example runs a previously tested or failed purge with batch ID 546781 from the point of failure.

purgeInstanceData(batchId='546781', testMode='FALSE')

Purges file system data corresponding to runtime instance data based on specified criteria. In the event of an unsupported operation, the command returns a WLSTException.

purgePayloads(arguments)

prgPLs(arguments)

For details about how to set MBean properties using Enterprise Manager, see Setting System MBean Properties for MFT WLST Commands.

The following example purges file system data corresponding to the runtime instance data previously purged by a purgeInstanceData command with the batch ID 546781. Detailed audits of purged files are performed, and the purge runs in the background.

purgePayloads(batchId='546781')

The following example purges file system data corresponding to the runtime instance data previously purged by a purgeInstanceData command with the batch ID 546781. Detailed audits of purged files are not performed, and the purge runs in the background.

purgePayloads(batchId='546781', detailedAudit='FALSE')

The following example purges file system data corresponding to the runtime instance data previously purged by a purgeInstanceData command with the batch ID 546781. Detailed audits of purged files are performed, and the purge occurs immediately.

purgePayloads(batchId='546781', detailedAudit='TRUE', runInSync='TRUE')