9 Oracle Managed File TransferでのWLSTコマンドの使用
Oracle Managed File Transfer (MFT)の操作を実行するWLST (Oracle WebLogic Scripting Tool)コマンドの使用方法を学習します。
この章の内容は次のとおりです。
MFTのWLSTコマンドの詳しい説明と例については、SOA Suite用WLSTコマンド・リファレンスのOracle Managed File TransferのカスタムWLSTコマンドに関する項を参照してください。
9.1 WLSTコマンドの実行
WLSTのコマンドを実行するには、あらかじめWLSTを起動してOracle Managed File Transfer専用のOracle WebLogic Server管理対象サーバーに接続しておく必要があります。
このプロセスのステップは次のとおりです。
9.2 MFTのWLSTコマンドの要約
様々なOracle Managed File Transferの操作を実行するWLST (Oracle WebLogic Scripting Tool)コマンドを使用します。
表9-1は、MFTのWLSTコマンドの要約です。これはクイック・リファレンスであり、各コマンドの詳しい説明を目的とするものではありません。これらのコマンドの詳しい説明は、『SOA Suite WLSTコマンド・リファレンス』のOracle Managed File TransferのカスタムWLSTコマンドに関する項を参照してください。
表9-1 MFTのWLSTコマンドの要約
| コマンド | ショートカット | 構文 | 説明 |
|---|---|---|---|
|
|
|
bulkDeployArtifact('TRANSFER|SOURCE|TARGET', 'artifact_names', 'comment')
|
ソース、転送またはターゲットのアーティファクトのカンマ区切りリストをデプロイします。*はすべてを意味します。コメントは省略可能です。 |
|
|
N/A |
createMftCredential(password, key)
|
|
|
|
|
deleteArtifact('TRANSFER|SOURCE|TARGET', 'artifact_name')
|
ソース、転送またはターゲットのアーティファクトを削除します。 |
|
|
|
deleteArtifactDeployment('TRANSFER|SOURCE|TARGET', 'artifact_name', 'label')
|
アンデプロイされたソース、転送またはターゲットのアーティファクトを削除します。古い構成履歴を削除するためにも使用します。「デプロイメント」タブの「デプロイメントの詳細の表示」を使用すると、 |
|
|
|
deployArtifact('TRANSFER|SOURCE|TARGET', 'artifact_name', 'comment')
|
ソース、転送またはターゲットのアーティファクトをデプロイします。コメントは省略可能です。 |
|
|
|
disableArtifact('TRANSFER|SOURCE|TARGET', 'artifact_name', 'comment')
|
デプロイ済で以前に有効化されたソース、転送またはターゲットのアーティファクトを無効にします。コメントは省略可能です。 |
|
|
|
enableArtifact('TRANSFER|SOURCE|TARGET', 'artifact_name', 'comment')
|
デプロイ済で以前に無効化されたソース、転送またはターゲットのアーティファクトを有効にします。コメントは省略可能です。 |
|
|
|
exportDeployedArtifact('artifact_type','artifact_name',label,'archive_file_path', generate_config_plan, long_format)
|
デプロイ済のソース、転送またはターゲットのアーティファクトをZIPファイルにエクスポートします。「デプロイメント」タブの「デプロイメントの詳細の表示」を使用すると、
|
|
|
|
isArtifactInMDS('TRANSFER|SOURCE|TARGET', 'artifact_name')
|
ソース、転送またはターゲットのアーティファクトがMDS (メタデータ・ストア)に存在するかどうかを調べて |
|
|
|
undeployArtifact('TRANSFER|SOURCE|TARGET', 'artifact_name', 'comment')
|
ソース、転送またはターゲットのアーティファクトを、構成から削除せずにアンデプロイします。コメントは省略可能です。 |
|
|
|
exportMetadata('archive_file', generate_config_plan, long_format)
|
MFT構成全体(パスワードを除く)をZIPファイルにエクスポートします。WLSTにリモート接続している場合は、ZIPファイルはリモート・サーバー上に作成されます。
|
|
|
|
exportTransferMetadata('archive_file', 'transfer_name', generate_config_plan, long_format)
|
転送アーティファクトおよび関連するメタデータをZIPファイルにエクスポートします。WLSTにリモート接続している場合は、ZIPファイルはリモート・サーバー上に作成されます。
|
|
|
|
importMetadata('archive_file', generate_config_plan, previewMode)
|
エクスポート済のMFT構成をZIPファイルからインポートします。
|
|
|
|
resetMetadata('preserve_preferences')
|
すべてのアーティファクトを削除し、すべての管理設定をデフォルトにリセットしてMFT構成をリセットします。 例:
|
|
|
|
deleteCSFKey('SSH|PGP|PEM', 'PRIVATE|PUBLIC', 'alias')脚注1 |
キー別名をMFTキーストアから削除します。 例:
|
|
|
|
exportCSFKey('SSH|PGP|PEM', 'PRIVATE|PUBLIC', 'zip_file_path')脚注1 |
キーをMFTキーストアから、キーを含むzipファイルにエクスポートします。 例:
ファイルを解凍してキーを抽出します。 |
|
|
|
generateKeys('SSH|PGP', 'password', 'key_file_path')
|
キーを生成して1つ以上のキー・ファイルに保存します。キーのタイプはRSAで、キーのサイズは1024ビットです。秘密キーのパスワードは省略可能です。 SSHの場合は、パスにキー・ファイル名が含まれている必要があります。 PGPの場合は、指定したパスの下に2つのファイルが生成されます。 OCIストレージ・クラウド・サービス・タイプがソースまたはターゲットとして選択されている場合にOracle Cloud Infrastructureへの接続に使用されるPEM形式の秘密RSAキーを生成するために、Oracle Managed File TransferコンソールまたはWSLT 例:
|
|
|
|
importCSFKey('SSH|PGP|PEM', 'PRIVATE|PUBLIC', 'alias', 'key_file_path')脚注1 |
キーをキー・ファイルからMFTキーストアにインポートして別名を作成します。 例:
OCIストレージ・クラウド・サービス・タイプをソースまたはターゲットとして使用する前に、PEM形式のRSAキーをインポートしてOracle Cloud Infrastructureに接続する必要があります。脚注1 例:
|
|
|
|
listCSFKeyAliases('SSH|PGP|PEM', 'PRIVATE|PUBLIC', 'alias')脚注1 |
MFTキーストア内のキー別名のリストを返します。 例:
|
|
|
|
updateCSFKey('SSH|PGP|PEM', 'PRIVATE|PUBLIC', 'alias', 'key_file_path')脚注1 |
キー別名をMFTキーストアから削除して新しいキー・ファイルを作成します。 例:
|
|
|
|
getSourceDeploymentHistory('source_name')
|
ソース・アーティファクトのデプロイメント履歴を返します。 |
|
|
|
getTargetDeploymentHistory('target_name')
|
ターゲット・アーティファクトのデプロイメント履歴を返します。 |
|
|
|
getTransferDeploymentHistory('transfer_name')
|
転送アーティファクトのデプロイメント履歴を返します。 |
|
|
|
getTransferInfo('transfer_name', 'label')
|
転送アーティファクトに関する情報を返します。「デプロイメント」タブの「デプロイメントの詳細の表示」を使用すると、 |
|
|
|
pauseTransfer('instance_id', 'comment')
|
進行中の転送を一時停止します。ターゲット・レポートの「拡張」セクションを開くと、インスタンスIDが表示されます。ターゲット・レポートの詳細は、「ソース、転送およびターゲットのレポートの解釈」を参照してください。コメントは省略可能です。 |
|
|
|
resubmit('resubmit_type', 'instance_id', 'comment', 'IsSync')
|
転送を再送信します。
ターゲット・レポートの詳細は、「ソース、転送およびターゲットのレポートの解釈」を参照してください。コメントは省略可能です。 例:
|
|
|
|
resubmitMessages(resubmit_type, state, artifact_name, start_date, end_date, chunk_size, chunk_delay, ignore_ids, comments, preview_mode) |
転送を一括で再送信します。 詳細は、「バルク再送信」を参照してください |
|
|
|
resumeTransfer('instance_id', 'comment')
|
一時停止している転送を再開します。ターゲット・レポートの「拡張」セクションを開くと、インスタンスIDが表示されます。ターゲット・レポートの詳細は、「ソース、転送およびターゲットのレポートの解釈」を参照してください。コメントは省略可能です。 |
|
|
|
configureHomeDir('directory_path', 'user_name')
|
指定されたディレクトリをホーム・ディレクトリとしてユーザーに割り当てます。そのユーザーが埋込みサーバーにログインしたときの作業ディレクトリとなります。 |
|
|
|
grantPermissionToDirectory('directory_path', 'principal_name', 'principal_type', 'permissions', 'server_type', 'include_subfolder')
|
埋込みサーバー・ディレクトリに対する権限を付与します。埋込みサーバー上の既存のディレクトリに対する権限のセットをユーザーやグループに割り当てることができます。 |
|
|
|
listAllPermissions(principal_name, server_types)
|
指定されたプリンシパルとサーバー・タイプに使用できるすべての権限のリストを返します。サーバー・タイプはFTPまたはsFTPです。次に例を示します。 wls:/mydomain/serverConfig> listAllPermissions("weblogic","FTP") |
|
|
|
createArtifacts('xml_file_fath', previewMode, updateIfExists)
|
アーティファクト定義を含む入力xmlファイルからアーティファクトを作成します。 |
|
|
|
revokePermissionForDirectory('directory_path', 'principal_name', 'principal_type', 'permissions', 'server_type', 'include_subfolder')
|
埋込みサーバー・ディレクトリに対する権限のセットを取り消します。 |
|
|
|
startEmbeddedServer('FTP|FTPS|SFTP')
|
停止している埋込みFTP、FTPS (FTP over SSL)またはsFTP (SSH-FTP)サーバーを起動します。 |
|
|
|
stopEmbeddedServer('FTP|FTPS|SFTP')
|
実行中の埋込みFTP、FTPS (FTP over SSL)またはsFTP (SSH-FTP)サーバーを停止します。 |
|
|
|
updatePorts('server_instance_name', 'FTP|FTPS|SFTP', 'port')
|
埋込みFTP、FTPS (FTP over SSL)またはsFTP (SSH-FTP)サーバーのポートを更新します。埋込みサーバーは、MFT専用のOracle WebLogic Server管理対象サーバーのサービスの1つです。 |
|
|
|
createCallouts('def_file_path')
|
コールアウトを定義するXMLファイルに基づいてコールアウトを作成します。 |
|
|
|
deleteCallout('callout_name')
|
コールアウトを削除します。 |
|
|
|
listCallouts()
|
コールアウトのリストを返します。 |
|
|
|
updateCallouts('def_file_path')
|
コールアウトを定義するXMLファイルに基づいて、同じ名前のコールアウトを更新します。 |
|
|
|
addContactToNotification('event', 'Email|PHONE|FAX|SMS', 'value')
|
特定のイベント通知に連絡先を追加します。
|
|
|
|
createContact('Email|PHONE|FAX|SMS', 'value')
|
イベント通知の連絡先を作成します。 |
|
|
|
deleteContact('Email|PHONE|FAX|SMS', 'value')
|
連絡先を削除します。 |
|
|
|
listContacts('Email|PHONE|FAX|SMS')
|
連絡先のリストを返します。 |
|
|
|
removeContactFromNotification('event', 'Email|PHONE|FAX|SMS', 'value')
|
特定のイベント通知から連絡先を削除します。
|
|
|
|
updateEvent('event', 'enabled')
|
特定のイベント通知を有効または無効にします。
|
|
|
|
archiveInstanceData(archiveFileName='filename', startDate='date', endDate='date', batchId='batchId', status='C|F|A|*', testMode='TRUE|FALSE', comments='text', runInSync='FALSE|TRUE', fsArchiveFolderPath='path')
|
ランタイム・インスタンスを |
|
|
|
restoreInstanceData(archiveFilePath='path', fileNamePrefix='prefix', fsFolderPath='path', runInSync='FALSE|TRUE')
|
アーカイブ済のランタイム・インスタンスを復元します。 |
|
|
|
archivePayloads(batchId='batchId', archivePath='path', runInSync='FALSE|TRUE')
|
ランタイム・インスタンスに対応するペイロードを |
|
|
|
restorePayloadsByName(fileNames='filename', folderPath='path', runInSync='FALSE|TRUE')
|
ファイル名で指定されたアーカイブ済ペイロードを復元します。 |
|
|
|
restorePayloadsByPrefix(fileNamePrefix='prefix', folderPath='path', runInSync='FALSE|TRUE')
|
ファイル名接頭辞で指定されたアーカイブ済ペイロードを復元します。 |
|
|
|
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)
|
ランタイム・インスタンスをパージします。引数はいずれも省略可能です。日付の形式は |
|
|
|
purgePayloads(batchId='batchId', detailedAudit='TRUE|FALSE', runInSync='FALSE|TRUE')
|
ランタイム・インスタンスに対応するペイロードをパージします。 |
|
|
|
createUserContact(user_name, delivery_channel)
|
新しいユーザー連絡先を作成します。これは、イベント通知に使用できます。
|
|
|
|
createUserGroupContact(user_group_name,delivery_channel)
|
新しいユーザー・グループ連絡先を作成します。これは、イベント通知に使用できます。
|
|
|
|
addUserContactToNotification(event, user_name, delivery_channel)
|
通知イベントのためのユーザー連絡先を追加します。 イベント値:
ノート: 内部連絡先を追加する前に、電子メール・アドレス/連絡先電話番号がユーザー設定にあることを確認してください。 |
|
|
|
addUserGroupContactToNotification(event, user_name, delivery_channel)
|
通知イベントのためのグループ・ユーザー連絡先を追加します。 イベント値:
|
|
|
|
deleteUserContact(user_name, delivery_channel)
|
既存のユーザー連絡先を削除します。ノート: 連絡先が使用されている(イベントに割り当てられている)場合、エラー・メッセージが表示されます。
|
|
|
|
deleteUserGroupContact(user_group_name,delivery_channel)
|
既存のユーザー・グループ連絡先を削除します。ノート: 連絡先が使用されている(イベントに割り当てられている)場合、エラー・メッセージが表示されます。
|
|
|
|
removeUserContactFromNotification(event, user_name, delivery_channel)
|
通知イベントから、指定したユーザー連絡先を削除します。 イベント値:
|
|
|
|
removeUserGroupContactFromNotification(event, user_group_name, delivery_channel)
|
通知イベントから、指定したユーザー・グループ連絡先を削除します。 イベント値:
|
triggerEvent |
trgEvt |
triggerEvent('source_name', 'properties') |
JCA/OCS/RIDCソースに対してイベントをトリガーし、ファイル転送を開始します。
|
updateTriggerEventStatus |
updTrgEvtSt |
updateTriggerEventStatus(status, source_name, event_session_id)
|
指定されたevent_session_idのTriggerEventステータスを更新します。
|
activatePurgeSchedule |
actPurgeSch |
activatePurgeSchedule(schedule_name)
|
パージ・スケジュールをアクティブ化します。アクティブ化するパージ・スケジュール名を指定します。デフォルトのschedule_nameは、デフォルトのパージ・スケジュールです。パージ・スケジュール名を指定しない場合、コマンドによってデフォルトのパージ・スケジュールがアクティブ化されます。このコマンドでアクティブ化できるパージ・スケジュールは1つだけです。
|
deactivatePurgeSchedule |
deactPurgeSch |
deactivatePurgeSchedule(schedule_name)
|
パージ・スケジュールを非アクティブ化します。非アクティブ化するパージ・スケジュール名を指定します。デフォルトのschedule_nameは、デフォルトのパージ・スケジュールです。パージ・スケジュール名を指定しない場合、コマンドによってデフォルトのパージ・スケジュールが非アクティブ化されます。このコマンドで非アクティブ化できるパージ・スケジュールは1つだけです。
|
modifyPurgeSchedule |
modifyPurgeSch |
modifyPurgeSchedule(start_date, end_date, schedule_time, frequency, retention_period, status, transfer_names, names_delimiter, include, comment)
|
既存のパージ・スケジュールを変更します。
retention_periodの値は任意の負でない数字、statusの値はCOMPLETEDまたはFAILED (あるいはその両方)、transfer_namesはインスタンスをパージする必要がある転送名、names_delimiterはシングル・キャラクタ文字列、includeの値はTRUEまたはFALSE、commentの値は任意の文字列です。
|
updateAppProperties |
updAppPrt |
updateAppProperties('properties_name_value_pair', 'delimiter')
|
MFTのアプリケーション・プロパティを更新します。サポートされているプロパティは、サーバー、HA、パフォーマンスおよび拡張プロパティです。プロパティが名前と値のペアであり、名前がプロパティ名、値がプロパティの値で、それぞれが区切り記号で区切られている場合、複数のプロパティを一度に更新できます。サポートされるパラメータは次のとおりです。physicalstoragedirectory: 文字列 - ディレクトリ・パス、 calloutdirectory: 文字列 - ディレクトリ・パス、 storeonlinepayload: 文字列 - {fileSystem, database}, storereferencepayload: ブール - true/false, generatechecksum: ブール - true/false, sourceprocessors: 数値 - ゼロ以外の正の数、 instanceprocessors: 数値 - ゼロ以外の正の数、targetprocessors: 数値 - ゼロ以外の正の数、controldirectory: 文字列 - ディレクトリ・パス、inbounddatasource: 文字列 - MFTデータ・ソース名、outbounddatasource: MFTデータ・ソース名、 internaladdress: 文字列 - ロード・バランサ(LB)のIPアドレス、internalFTPS: 数値 - LBのFTPSのポート番号、internalSFTP: 数値 - LBのSFTPのポート番号、 internalFTP: 数値 - LBのFTPのポート番号、 externaladdress: 文字列 - LBのIPアドレス、externalFTPS: 数値 - LBのFTPSのポート番号、 externalSFTP: 数値 - LBのSFTPのポート番号、 externalFTP: 数値 - LBのFTPのポート番号。
|
updateSFTPServer |
updSFTPSvr |
updateSFTPServer('enable_SFTP', 'key_alias', 'private_key_password')
|
組込みSFTPサーバーを有効化または無効化するために使用されます。SFTPサーバーを有効化するには、オプションの秘密キーのパスワードに加えて、SSHキーの別名が必須です。キーがパスワードで保護されていない場合は、秘密キーのパスワードは不要です。無効化するには、キーの別名もパスワードも不要です。サポートされているパラメータ: enable_SFTP: SFTPを有効化または無効化するためのブール値、key_alias: SSH秘密キー別名、private_key_password: SSH秘密キーのオプション・パスワード。
|
脚注1
OCIストレージ・クラウド・サービスがソースまたはターゲットとして選択されている場合、PEM形式のRSAキーを使用してOracle Cloud Infrastructureに接続します。
PEM形式のRSAキーの場合、PRIVATEのみが有効です。
OCIストレージ・クラウド・サービス・タイプおよびPEMのキー形式は、パッチ32395225をインストールした場合にのみ12c (12.2.1.4)で使用できます。My Oracle Supportにサインインし、パッチ番号でパッチを検索してダウンロードします。