This chapter summarizes 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.
Before you can run WLST commands, you must start WLST and connect to the Oracle WebLogic Server managed server dedicated to MFT.
The steps for this process are:
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('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(password, key) |
Create the credential for mftapp. Enter the password for which credential needs to be created and the key for the credential. |
|
|
|
deleteArtifact('TRANSFER|SOURCE|TARGET',
'artifact_name')
|
Deletes a source, transfer, or target artifact. |
|
|
deleteArtifactDeployment('TRANSFER|SOURCE|TARGET', 'artifact_name', 'label') |
Deletes an undeployed source, transfer, or target artifact. Use Show Deployment Details on the Deployment tab to view the |
|
|
deployArtifact('TRANSFER|SOURCE|TARGET', 'artifact_name', 'comment') |
Deploys a source, transfer, or target artifact. A comment is optional. |
|
|
disableArtifact('TRANSFER|SOURCE|TARGET', 'artifact_name', 'comment') |
Disables a deployed and previously enabled source, transfer, or target artifact. A comment is optional. |
|
|
enableArtifact('TRANSFER|SOURCE|TARGET', 'artifact_name', 'comment') |
Enables a deployed and previously disabled source, transfer, or target artifact. A comment is optional. |
|
|
exportDeployedArtifact('TRANSFER|SOURCE|TARGET', 'artifact_name', 'label', 'archive_file_path') |
Exports a deployed source, transfer, or target artifact to a ZIP file. Use Show Deployment Details on the Deployment tab to view the |
|
|
isArtifactInMDS('TRANSFER|SOURCE|TARGET',
'artifact_name')
|
Checks whether a source, transfer, or target artifact exists in the MDS (Metadata Store) and returns |
|
|
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('archive_file_path')
|
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. |
|
|
exportTransferMetadata('archive_file_path', 'transfer_name') |
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. |
|
|
importMetadata('archive_file_path')
|
Imports a previously exported MFT configuration from a ZIP file. |
|
|
resetMetadata('preserve_preferences')
|
Resets the MFT configuration, deleting all artifacts and resetting all administrative settings to their defaults, while preserving user preferences if optional |
|
|
deleteCSFKey('SSH|PGP', 'PRIVATE|PUBLIC', 'alias')
|
Deletes a key alias from the MFT keystore. |
|
|
exportCSFKey('SSH|PGP', 'PRIVATE|PUBLIC',
'key_file_path')
|
Exports keys from the MFT keystore to a key file. |
|
|
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 For additional key generation options that are not supported by |
|
|
importCSFKey('SSH|PGP', 'PRIVATE|PUBLIC', 'alias', 'key_file_path') |
Imports a key to the MFT keystore from a key file and creates an alias. |
|
|
listCSFKeyAliases('SSH|PGP', 'PRIVATE|PUBLIC',
'alias')
|
Lists key aliases in the MFT keystore. |
|
|
updateCSFKey('SSH|PGP', 'PRIVATE|PUBLIC', 'alias', 'key_file_path') |
Deletes a key alias from the MFT keystore and generates a new key file. |
|
|
getSourceDeploymentHistory('source_name')
|
Returns the deployment history of a source artifact. |
|
|
getTargetDeploymentHistory('target_name')
|
Returns the deployment history of a target artifact. |
|
|
getTransferDeploymentHistory('transfer_name')
|
Returns the deployment history of a transfer artifact. |
|
|
getTransferInfo('transfer_name', 'label') |
Returns information about a transfer artifact. Use Show Deployment Details on the Deployment tab to view the |
|
|
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('resubmit_type', 'instance_ids', 'comment') |
Resubmits a transfer. The |
|
|
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('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('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. |
|
|
grantPermissionToDirectory('directory_path', 'server_type') |
Lists all permissions available for a given principal and server type. The server type can be FTP or sFTP. |
|
|
revokePermissionForDirectory('directory_path', 'principal_name', 'principal_type', 'permissions', 'server_type', 'include_subfolder') |
Revokes a set of permissions from an embedded server directory. |
|
|
startEmbeddedServer('FTP|FTPS|SFTP') |
Starts an embedded FTP, FTPS (FTP over SSL), or sFTP (SSH-FTP) server that was stopped. |
|
|
stopEmbeddedServer('FTP|FTPS|SFTP') |
Stops an embedded FTP, FTPS (FTP over SSL), or sFTP (SSH-FTP) server that is running. |
|
|
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('def_file_path')
|
Creates callouts based on an XML file that defines them. |
|
|
deleteCallout('callout_name')
|
Deletes a callout. |
|
|
listCallouts() |
Lists callouts. |
|
|
updateCallouts('def_file_path')
|
Updates callouts with the same names based on an XML file that defines them. |
|
|
addContactToNotification('event', 'Email|PHONE|FAX|SMS', 'value') |
Adds a contact to a specific event notification. The The |
|
|
createContact('Email|PHONE|FAX|SMS', 'value')
|
Creates a contact for event notifications. The |
|
|
deleteContact('Email|PHONE|FAX|SMS', 'value')
|
Deletes a contact. The |
|
|
listContacts('Email|PHONE|FAX|SMS') |
Lists contacts. |
|
|
removeContactFromNotification('event', 'Email|PHONE|FAX|SMS', 'value') |
Removes a contact from a specific event notification. The The |
|
|
updateEvent('event', 'enabled') |
Enables or disables a specific event notification. Set The |
|
|
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 |
|
|
restoreInstanceData(archiveFilePath='path', fileNamePrefix='prefix', fsFolderPath='path', runInSync='FALSE|TRUE') |
Restores previously archived runtime instances. The |
|
|
archivePayloads(batchId='batchId', archivePath='path', runInSync='FALSE|TRUE') |
Archives payloads corresponding to runtime instances to |
|
|
restorePayloadsByName(fileNames='filename', folderPath='path', runInSync='FALSE|TRUE') |
Restores previously archived payloads by file name. The |
|
|
restorePayloadsByPrefix(fileNamePrefix='prefix', folderPath='path', runInSync='FALSE|TRUE') |
Restores previously archived payloads by file name prefix. The |
|
|
purgeInstanceData(startDate='date', endDate='date', batchId='batchId', status='C|F|A|*', testMode='TRUE|FALSE', comments='text', runInSync='FALSE|TRUE', runPayloadPurge='FALSE|TRUE') |
Purges runtime instances. All arguments are optional. Dates are in |
|
|
purgePayloads(batchId='batchId',
detailedAudit='TRUE|FALSE',
runInSync='FALSE|TRUE')
|
Purges payloads corresponding to runtime instances. The |
Note:
MFT WLST command shortcuts are shorthand aliases for the MFT WLST commands. These can be substituted for the full command names if preferred. There is no difference in the command behavior between using the full command names or the shortcut command names.