ヘッダーをスキップ
Oracle® Fusion Middleware SOA Suite WLSTコマンド・リファレンス
12c (12.2.1)
E72530-01
  目次へ移動
目次

前
 

5 Oracle Managed File TransferのカスタムWLSTコマンド

この章では、Oracle Managed File Transfer (MFT)の操作を実行するWLST (Oracle WebLogic Scripting Tool)コマンドの要約を示します。

この章の内容は次のとおりです。

WLSTの全般的な情報は、『WebLogic Server WLSTコマンド・リファレンス』を参照してください。

MFTの全般的な情報は、「Oracle Managed File Transferの使用」を参照してください。

5.1 MFT WLSTコマンド・カテゴリの概要

MFT WLSTコマンドは、次のカテゴリに分類されます。


表5-1 MFT WLSTコマンド・カテゴリ

コマンド・カテゴリ 説明

MFTアーティファクト管理コマンド

ソース、転送およびターゲットのアーティファクトで、有効化、無効化、デプロイ、アンデプロイ、削除、エクスポート、メタデータ・ストア(MDS)での存在のチェックの操作を実行します。

MFTメタデータ・コマンド

MFTメタデータをエクスポート、インポートおよびリセットします。

MFT鍵管理コマンド

MFTキーストアのSSL、SSHおよびPGP鍵を生成、インポート、エクスポート、削除、一覧表示および更新します。

MFTデプロイメント履歴コマンド

ソース、転送およびターゲットのアーティファクトのデプロイメント履歴を表示します。

MFT転送管理コマンド

転送インスタンスについての情報を一時停止、再開、再発行または表示します。

MFT埋込みサーバー・コマンド

埋込みFTPおよびsFTPサーバーのポートを起動、停止および変更します。

MFTコールアウト・コマンド

カスタム・コールアウトを作成、削除、一覧表示および更新します。

MFTイベント通知コマンド

  • 連絡先を作成、削除および一覧表示します。

  • イベント通知から連絡先を追加および削除します。

  • イベント通知を有効および無効にします。

MFTアーカイブおよび復元コマンド

ステータスや日付範囲などの基準に基づいて転送インスタンスまたはファイル・システム・データをアーカイブします。

MFTパージ・コマンド

ステータスや日付範囲などの基準に基づいて転送インスタンスまたはファイル・システム・データをパージします。


5.2 MFTアーティファクト管理コマンド

ソース、転送およびターゲットのアーティファクトで操作を実行するには、表5-2に示されたMFT WLSTアーティファクト管理コマンドを使用します。


表5-2 MFTアーティファクト管理WLSTコマンド

使用するコマンド 用途 使用するWLST

bulkDeployArtifact

複数のソース、転送またはターゲットのアーティファクトをデプロイします。

オンラインまたはオフライン

deleteArtifactまたはdelAF

ソース、転送またはターゲットのアーティファクトを削除します。

オンラインまたはオフライン

deleteArtifactDeploymentまたはdelDepAF

アンデプロイされたソース、転送またはターゲットのアーティファクトを削除します。

オンラインまたはオフライン

deployArtifactまたはdepAF

ソース、転送またはターゲットのアーティファクトをデプロイします。

オンラインまたはオフライン

disableArtifactまたはdisAF

デプロイ済のソース、転送またはターゲットのアーティファクトを無効にします。

オンラインまたはオフライン

enableArtifactまたはenAF

デプロイ済のソース、転送またはターゲットのアーティファクトを有効にします。

オンラインまたはオフライン

exportDeployedArtifactまたはexpDepAF

デプロイ済のソース、転送またはターゲットのアーティファクトをZIPファイルにエクスポートします。

オンラインまたはオフライン

isArtifactInMDSまたはisAFinMDS

ソース、転送またはターゲットのアーティファクトがMDS(メタデータ・ストア)に存在するかどうかをチェックします。

オンラインまたはオフライン

undeployArtifactまたはundepAF

ソース、転送またはターゲットのアーティファクトをアンデプロイします。

オンラインまたはオフライン


5.2.1 bulkDeployArtifact

コマンド・カテゴリ: MFTアーティファクト管理コマンド

WLSTでの使用: オンラインまたはオフライン

5.2.1.1 説明

複数のソース、転送またはターゲットのアーティファクトを一括デプロイします。サポートされない操作の場合は、WLSTExceptionを返します。

5.2.1.2 構文

bulkDeployArtifact(artifact_type, artifact_names, comment)
引数 定義
artifact_type

アーティファクト・タイプ: SOURCETRANSFERまたはTARGET

artifact_names

カンマ区切りのアーティファクト名、またはすべてに対しては*

comment

アーティファクトの説明またはそれらをデプロイする理由を示す文字列。

5.2.1.3

次の例では、2つのSOURCEアーティファクトをデプロイし、コメントを付けます。

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

次の例では、すべてのTRANSFERアーティファクトをデプロイし、コメントを付けます。

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

5.2.2 deleteArtifact

コマンド・カテゴリ: MFTアーティファクト管理コマンド

WLSTでの使用: オンラインまたはオフライン

5.2.2.1 説明

ソース、転送またはターゲットのアーティファクトを削除します。サポートされない操作の場合は、WLSTExceptionを返します。

5.2.2.2 構文

deleteArtifact(artifact_type, artifact_name)
delAF(artifact_type, artifact_name)
引数 定義
artifact_type

アーティファクト・タイプ: SOURCETRANSFERまたはTARGET

artifact_name

アーティファクト名。

5.2.2.3

次の例では、order-file-srcというSOURCEアーティファクトを削除します。

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

5.2.3 deleteArtifactDeployment

コマンド・カテゴリ: MFTアーティファクト管理コマンド

WLSTでの使用: オンラインまたはオフライン

5.2.3.1 説明

アンデプロイされたソース、転送またはターゲットのアーティファクトを削除します。サポートされない操作の場合は、WLSTExceptionを返します。

5.2.3.2 構文

deleteArtifactDeployment(artifact_type, artifact_name, label)
delDepAF(artifact_type, artifact_name, label)
引数 定義
artifact_type

アーティファクト・タイプ: SOURCETRANSFERまたはTARGET

artifact_name

アーティファクト名。

label

MDS (メタデータ・ストア)でのアーティファクト・ラベル。

このラベルを表示するには、「デプロイメント」タブの「デプロイメントの詳細の表示」を使用します。

5.2.3.3

次の例では、ラベルsoa_mft-2012-12-07 22:24:09.383の付いたorder-file-srcというSOURCEアーティファクトを削除します。

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

5.2.4 deployArtifact

コマンド・カテゴリ: MFTアーティファクト管理コマンド

WLSTでの使用: オンラインまたはオフライン

5.2.4.1 説明

ソース、転送またはターゲットのアーティファクトをデプロイします。サポートされない操作の場合は、WLSTExceptionを返します。

5.2.4.2 構文

deployArtifact(artifact_type, artifact_name, comment)
depAF(artifact_type, artifact_name, comment)
引数 定義
artifact_type

アーティファクト・タイプ: SOURCETRANSFERまたはTARGET

artifact_name

アーティファクト名。

comment

アーティファクトの説明またはアーティファクトをデプロイする理由を示す文字列。

5.2.4.3

次の例では、order-file-srcというSOURCEアーティファクトをデプロイし、このアーティファクトについてのコメントを付けます。

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

5.2.5 disableArtifact

コマンド・カテゴリ: MFTアーティファクト管理コマンド

WLSTでの使用: オンラインまたはオフライン

5.2.5.1 説明

デプロイ済で以前に有効化されたソース、転送またはターゲットのアーティファクトを無効にします。サポートされない操作の場合は、WLSTExceptionを返します。

5.2.5.2 構文

disableArtifact(artifact_type, artifact_name, comment)
disAF(artifact_type, artifact_name, comment)
引数 定義
artifact_type

アーティファクト・タイプ: SOURCETRANSFERまたはTARGET

artifact_name

アーティファクト名。

comment

アーティファクトの説明またはアーティファクトを無効にする理由を示す文字列。

5.2.5.3

次の例では、order-file-srcというSOURCEアーティファクトを無効にし、その理由についてのコメントを付けます。

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

5.2.6 enableArtifact

コマンド・カテゴリ: MFTアーティファクト管理コマンド

WLSTでの使用: オンラインまたはオフライン

5.2.6.1 説明

デプロイ済で以前に無効化されたソース、転送またはターゲットのアーティファクトを有効にします。サポートされない操作の場合は、WLSTExceptionを返します。

5.2.6.2 構文

enableArtifact(artifact_type, artifact_name, comment)
enAF(artifact_type, artifact_name, comment)
引数 定義
artifact_type

アーティファクト・タイプ: SOURCETRANSFERまたはTARGET

artifact_name

アーティファクト名。

comment

アーティファクトの説明またはアーティファクトを有効にする理由を示す文字列。

5.2.6.3

次の例では、order-file-srcというSOURCEアーティファクトを有効にし、その理由についてのコメントを付けます。

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

5.2.7 exportDeployedArtifact

コマンド・カテゴリ: MFTアーティファクト管理コマンド

WLSTでの使用: オンラインまたはオフライン

5.2.7.1 説明

デプロイ済のソース、転送またはターゲットのアーティファクトをZIPファイルにエクスポートします。サポートされない操作の場合は、WLSTExceptionを返します。

5.2.7.2 構文

exportDeployedArtifact(artifact_type, artifact_name, label, archive_file_path)
expDepAF(artifact_type, artifact_name, label, archive_file_path)
引数 定義
artifact_type

アーティファクト・タイプ: SOURCETRANSFERまたはTARGET

artifact_name

アーティファクト名。

label

MDS (メタデータ・ストア)でのアーティファクト・ラベル。

このラベルを表示するには、「デプロイメント」タブの「デプロイメントの詳細の表示」を使用します。

archive_file_path

エクスポートするZIPファイルへのフルパス。WLSTにリモート接続している場合は、ZIPファイルはリモート・サーバー上に作成されます。

5.2.7.3

次の例では、ラベルsoa_mft-2012-12-07 22:24:09.383の付いたorder-file-srcというSOURCEアーティファクトを/export/order-file-src.zipにエクスポートします。

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

5.2.8 isArtifactInMDS

コマンド・カテゴリ: MFTアーティファクト管理コマンド

WLSTでの使用: オンラインまたはオフライン

5.2.8.1 説明

ソース、転送またはターゲットのアーティファクトがMDS (メタデータ・ストア)に存在するかどうかを調べてTRUEまたはFALSEを返します。サポートされない操作の場合は、WLSTExceptionを返します。

5.2.8.2 構文

isArtifactInMDS(artifact_type, artifact_name)
isAFinMDS(artifact_type, artifact_name)
引数 定義
artifact_type

アーティファクト・タイプ: SOURCETRANSFERまたはTARGET

artifact_name

アーティファクト名。

5.2.8.3

次の例では、order-file-srcというSOURCEアーティファクトがMDSに存在しているかどうかをチェックします。

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

5.2.9 undeployArtifact

コマンド・カテゴリ: MFTアーティファクト管理コマンド

WLSTでの使用: オンラインまたはオフライン

5.2.9.1 説明

ソース、転送またはターゲットのアーティファクトを、構成から削除せずにアンデプロイします。サポートされない操作の場合は、WLSTExceptionを返します。

5.2.9.2 構文

undeployArtifact(artifact_type, artifact_name, comment)
undepAF(artifact_type, artifact_name, comment)
引数 定義
artifact_type

アーティファクト・タイプ: SOURCETRANSFERまたはTARGET

artifact_name

アーティファクト名。

comment

アーティファクトの説明またはアーティファクトをアンデプロイする理由を示す文字列。

5.2.9.3

次の例では、order-file-srcというSOURCEアーティファクトをアンデプロイし、その理由についてのコメントを付けます。

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

5.3 MFTメタデータ・コマンド

メタデータ操作を実行するには、表5-3に示されたMFT WLSTメタデータ・コマンドを使用します。


表5-3 MFTメタデータWLSTコマンド

使用するコマンド 用途 使用するWLST

exportMetadataまたはexpMD

MFT構成全体(パスワードを除く)をZIPファイルにエクスポートします。

オンラインまたはオフライン

exportTransferMetadataまたはexpXfrMD

転送アーティファクトおよび関連するメタデータをZIPファイルにエクスポートします。

オンラインまたはオフライン

importMetadataまたはimpMD

エクスポート済のMFT構成をZIPファイルからインポートします。

オンラインまたはオフライン

resetMetadataまたはresMD

すべてのアーティファクトを削除し、すべての管理設定をデフォルトにリセットしてMFT構成をリセットし、オプションでユーザーのプリファレンスは保持します。

オンラインまたはオフライン


5.3.1 exportMftMetadata

コマンド・カテゴリ: MFTメタデータ・コマンド

WLSTでの使用: オンラインまたはオフライン

5.3.1.1 説明

MFT構成全体(パスワードを除く)をZIPファイルにエクスポートします。サポートされない操作の場合は、WLSTExceptionを返します。

5.3.1.2 構文

exportMftMetadata(archive_file_path)
expMD(archive_file_path)
引数 定義
archive_file_path

エクスポートするZIPファイルへのフルパス。

5.3.1.3

次の例では、MFT構成を/export/mft-config-dec-2012.zipにエクスポートします。

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

5.3.2 exportTransferMetadata

コマンド・カテゴリ: MFTメタデータ・コマンド

WLSTでの使用: オンラインまたはオフライン

5.3.2.1 説明

転送アーティファクトおよび関連するメタデータをZIPファイルにエクスポートします。サポートされない操作の場合は、WLSTExceptionを返します。

5.3.2.2 構文

exportTransferMetadata(archive_file_path, transfer_name)
expXfrMD(archive_file_path, transfer_name)
引数 定義
archive_file_path

エクスポートするZIPファイルへのフルパス。

transfer_name

転送アーティファクト名。

5.3.2.3

次の例では、order-xfrという名前の転送アーティファクトとそのメタデータを/export/order-xfr.zipにエクスポートします。

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

5.3.3 importMftMetadata

コマンド・カテゴリ: MFTメタデータ・コマンド

WLSTでの使用: オンラインまたはオフライン

5.3.3.1 説明

エクスポート済のMFT構成をZIPファイルからインポートします。サポートされない操作の場合は、WLSTExceptionを返します。

5.3.3.2 構文

importMftMetadata(archive_file_path)
impMD(archive_file_path)
引数 定義
archive_file_path

エクスポートするZIPファイルへのフルパス。

5.3.3.3

次の例では、MFT構成を/export/mft-config-dec-2012.zipからインポートします。

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

5.3.4 resetMetadata

コマンド・カテゴリ: MFTメタデータ・コマンド

WLSTでの使用: オンラインまたはオフライン

5.3.4.1 説明

すべてのアーティファクトを削除し、すべての管理設定をデフォルトにリセットしてMFT構成をリセットし、オプションでユーザーのプリファレンスは保持します。サポートされない操作の場合は、WLSTExceptionを返します。

5.3.4.2 構文

resetMetadata(preserve_preferences)
resMD(preserve_preferences)
引数 定義
preserve_preferences

TRUEの場合、ユーザーのプリファレンスを保持します。FALSEの場合、構成のリセットとともにユーザーのプリファレンスをリセットします。

5.3.4.3

次の例ではMFT構成をリセットしますが、ユーザーのプリファレンスは保持します。

resetMetadata('TRUE')

5.4 MFT鍵管理コマンド

MFTキーストアでSSL、SSHおよびPGPの鍵の管理を行うには、表5-4のMFT WLST鍵管理コマンドを使用します。詳細は、Oracle Managed File Transferの使用のキーストア管理に関する項を参照してください。


表5-4 MFT鍵管理WLSTコマンド

使用するコマンド 用途 使用するWLST

deleteCSFKeyまたはdelKey

鍵別名をMFTキーストアから削除します。

オンラインまたはオフライン

exportCSFKeyまたはexpKey

鍵をMFTキーストアからキー・ファイルにエクスポートします。

オンラインまたはオフライン

generateKeysまたはgenKeys

鍵を生成して1つ以上のキー・ファイルに保存します。

オンラインまたはオフライン

importCSFKeyまたはimpKey

鍵をキー・ファイルからMFTキーストアにインポートします。

オンラインまたはオフライン

listCSFKeyAliasesまたはlsKeyAliases

MFTキーストア内の鍵別名をリストします。

オンラインまたはオフライン

updateCSFKeyまたはupdKey

鍵別名をMFTキーストアから削除して新しいキー・ファイルを作成します。

オンラインまたはオフライン


5.4.1 deleteCSFKey

コマンド・カテゴリ: MFT鍵管理コマンド

WLSTでの使用: オンラインまたはオフライン

5.4.1.1 説明

鍵別名をMFTキーストアから削除します。サポートされない操作の場合は、WLSTExceptionを返します。

5.4.1.2 構文

deleteCSFKey(key_format, key_type, alias)
delKey(key_format, key_type, alias)
引数 定義
key_format

鍵の書式: SSHまたはPGP

key_type

鍵の書式: PRIVATEまたはPUBLIC

alias

鍵別名。

5.4.1.3

次の例では、別名my-aliasPRIVATE SSH鍵を削除します。

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

5.4.2 exportCSFKey

コマンド・カテゴリ: MFT鍵管理コマンド

WLSTでの使用: オンラインまたはオフライン

5.4.2.1 説明

鍵をMFTキーストアからキー・ファイルにエクスポートします。サポートされない操作の場合は、WLSTExceptionを返します。

5.4.2.2 構文

exportCSFKey(key_format, key_type, key_file_path)
expKey(key_format, key_type, key_file_path)
引数 定義
key_format

鍵の書式: SSHまたはPGP

key_type

鍵の書式: PRIVATEまたはPUBLIC

key_file_path

エクスポート先のキー・ファイルへのフルパス。

5.4.2.3

次の例では、PRIVATE SSH鍵をファイル/export/ssh/my_private_keys.ppkにエクスポートします。

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

5.4.3 generateKeys

コマンド・カテゴリ: MFT鍵管理コマンド

WLSTでの使用: オンラインまたはオフライン

5.4.3.1 説明

鍵を生成して1つ以上のキー・ファイルに保存します。鍵のタイプはRSAで、鍵のサイズは1024ビットです。サポートされない操作の場合は、WLSTExceptionを返します。

5.4.3.2 構文

generateKeys(key_format, password, key_file_path)
genKeys(key_format, password, key_file_path)
引数 定義
key_format

鍵の書式: SSHまたはPGP

password

秘密鍵用のオプションのパスワード。

key_file_path

生成されたキー・ファイルまたはディレクトリへのフルパス。

SSHの場合は、パスにキー・ファイル名が含まれている必要があります。

PGPの場合は、指定したパスの下に2つのファイルが生成されます。secret.ascファイルの内容はPGP秘密鍵で、pub.ascファイルの内容はPGP公開鍵です。

5.4.3.3

次の例では、SSH鍵をパスワード保護なしでファイル/export/ssh/ssh-pvt-keys.ppkにエクスポートします。

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

次の例では、PGP鍵をパスワード保護なしでディレクトリ/export/pgpにエクスポートします。

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

5.4.4 importCSFKey

コマンド・カテゴリ: MFT鍵管理コマンド

WLSTでの使用: オンラインまたはオフライン

5.4.4.1 説明

鍵をキー・ファイルからMFTキーストアにインポートして別名を作成します。サポートされない操作の場合は、WLSTExceptionを返します。

5.4.4.2 構文

importCSFKey(key_format, key_type, alias, key_file_path)
impKey(key_format, key_type, alias, key_file_path)
引数 定義
key_format

鍵の書式: SSHまたはPGP

key_type

鍵の書式: PRIVATEまたはPUBLIC

alias

鍵別名。

key_file_path

インポート元のキー・ファイルへのフルパス。

5.4.4.3

次の例では、別名my-aliasPRIVATE SSH鍵をファイル/export/ssh/my_private_keys.ppkからインポートします。

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

次の例では、別名mftpgppubPUBLIC PGP鍵をファイル/export/pgp/pub.ascからインポートします。

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

次の例では、別名mftpgppriPRIVATE PGP鍵をファイル/export/pgp/secret.ascからインポートします。

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

5.4.5 listCSFKeyAliases

コマンド・カテゴリ: MFT鍵管理コマンド

WLSTでの使用: オンラインまたはオフライン

5.4.5.1 説明

MFTキーストア内の鍵別名のリストを返します。サポートされない操作の場合は、WLSTExceptionを返します。

5.4.5.2 構文

listCSFKeyAliases(key_format, key_type, alias)
lsKeyAliases(key_format, key_type, alias)
引数 定義
key_format

鍵の書式: SSHまたはPGP

key_type

鍵の書式: PRIVATEまたはPUBLIC

5.4.5.3

次の例では、PRIVATE SSH鍵を一覧表示します。

listCSFKeyAliases('SSH', 'PRIVATE')

5.4.6 updateCSFKey

コマンド・カテゴリ: MFT鍵管理コマンド

WLSTでの使用: オンラインまたはオフライン

5.4.6.1 説明

鍵別名をMFTキーストアから削除して新しいキー・ファイルを作成します。サポートされない操作の場合は、WLSTExceptionを返します。

5.4.6.2 構文

updateCSFKey(key_format, key_type, alias, key_file_path)
updKey(key_format, key_type, alias, key_file_path)
引数 説明
key_format

鍵の書式: SSHまたはPGP

key_type

鍵の書式: PRIVATEまたはPUBLIC

alias

鍵別名。

key_file_path

作成するキー・ファイルへのフルパス。

5.4.6.3

次の例では、別名my-aliasPRIVATE SSH鍵を削除し、キー・ファイル/export/ssh/my-private-key.ppkを作成します。

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

5.5 MFTデプロイメント履歴コマンド

ソース、転送およびターゲットのアーティファクトのデプロイメント履歴を表示するには、表5-5に示されたMFT WLSTデプロイメント履歴コマンドを使用します。


表5-5 MFTデプロイメント履歴WLSTコマンド

使用するコマンド 用途 使用するWLST

getSourceDeploymentHistoryまたはgetSrcDH

ソース・アーティファクトのデプロイメント履歴を返します。

オンラインまたはオフライン

getTargetDeploymentHistoryまたはgetTrgtDH

ターゲット・アーティファクトのデプロイメント履歴を返します。

オンラインまたはオフライン

getTransferDeploymentHistoryまたはgetXfrDH

転送アーティファクトのデプロイメント履歴を返します。

オンラインまたはオフライン


5.5.1 getSourceDeploymentHistory

コマンド・カテゴリ: MFTデプロイメント履歴コマンド

WLSTでの使用: オンラインまたはオフライン

5.5.1.1 説明

ソース・アーティファクトのデプロイメント履歴を返します。サポートされない操作の場合は、WLSTExceptionを返します。

5.5.1.2 構文

getSourceDeploymentHistory(source_name)
getSrcDH(source_name)
引数 定義
source_name

ソース・アーティファクト名。

5.5.1.3

次の例では、order-file-srcという名前のソース・アーティファクトのデプロイメント履歴を返します。

getSourceDeploymentHistory('order-file-src')

5.5.2 getTargetDeploymentHistory

コマンド・カテゴリ: MFTデプロイメント履歴コマンド

WLSTでの使用: オンラインまたはオフライン

5.5.2.1 説明

ターゲット・アーティファクトのデプロイメント履歴を返します。サポートされない操作の場合は、WLSTExceptionを返します。

5.5.2.2 構文

getTargetDeploymentHistory(target_name)
getTrgtDH(target_name)
引数 定義
target_name

ターゲット・アーティファクト名。

5.5.2.3

次の例では、order-file-tgtという名前のターゲット・アーティファクトのデプロイメント履歴を返します。

getTargetDeploymentHistory('order-file-tgt')

5.5.3 getTransferDeploymentHistory

コマンド・カテゴリ: MFTデプロイメント履歴コマンド

WLSTでの使用: オンラインまたはオフライン

5.5.3.1 説明

転送アーティファクトのデプロイメント履歴を返します。サポートされない操作の場合は、WLSTExceptionを返します。

5.5.3.2 構文

getTransferDeploymentHistory(transfer_name)
getXfrDH(transfer_name)
引数 定義
transfer_name

転送アーティファクト名。

5.5.3.3

次の例では、order-xfrという名前の転送アーティファクトのデプロイメント履歴を返します。

getTransferDeploymentHistory('order-xfr')

5.6 MFT転送管理コマンド

転送インスタンスを管理するには、表5-6に示されたMFT WLST転送管理コマンドを使用します。


表5-6 MFT転送管理WLSTコマンド

使用するコマンド 用途 使用するWLST

getTransferInfoまたはgetXfrInfo

転送アーティファクトに関する情報を返します。

オンラインまたはオフライン

pauseTransferまたはpauseXfr

進行中の転送を一時停止します。

オンラインまたはオフライン

resubmitまたはresub

失敗した転送を再発行します。

オンラインまたはオフライン

resumeTransferまたはresXfr

一時停止している転送を再開します。

オンラインまたはオフライン


5.6.1 getTransferInfo

コマンド・カテゴリ: MFT転送管理コマンド

WLSTでの使用: オンラインまたはオフライン

5.6.1.1 説明

転送アーティファクトに関する情報を返します。サポートされない操作の場合は、WLSTExceptionを返します。

5.6.1.2 構文

getTransferInfo(transfer_name, label)
getXfrInfo(transfer_name, label)
引数 定義
transfer_name

転送アーティファクト名。

label

MDS (メタデータ・ストア)でのアーティファクト・ラベル。

このラベルを表示するには、「デプロイメント」タブの「デプロイメントの詳細の表示」を使用します。

5.6.1.3

次の例では、ラベルsoa_mft-2012-12-07 22:28:17.392の付いたorder-xfrという名前の転送アーティファクトについての情報が返されます。

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

5.6.2 pauseTransfer

コマンド・カテゴリ: MFT転送管理コマンド

WLSTでの使用: オンラインまたはオフライン

5.6.2.1 説明

進行中の転送を一時停止します。サポートされない操作の場合は、WLSTExceptionを返します。

5.6.2.2 構文

pauseTransfer(instance_id, comment)
pauseXfr(instance_id, comment)
引数 定義
instance_id

転送用のターゲット・インスタンスID。

ターゲット・レポートの「拡張」セクションを開くと、インスタンスIDが表示されます。ターゲット・レポートの詳細は、Oracle Managed File Transferの使用のソース、転送およびターゲットのレポートの解釈に関する項を参照してください。

comment

一時停止の理由を説明する文字列。

5.6.2.3

次の例では、ターゲット・インスタンスID 240C93AD-5401-483B-8182-274FA0705DF1の転送を一時停止し、その理由を示します。

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

5.6.3 resubmit

コマンド・カテゴリ: MFT転送管理コマンド

WLSTでの使用: オンラインまたはオフライン

5.6.3.1 説明

転送を再送信します。成功または失敗した転送を再送信できます。サポートされない操作の場合は、WLSTExceptionを返します。

5.6.3.2 構文

resubmit(resubmit_type, instance_ids, comment)
resub(resubmit_type, instance_ids, comment)
引数 定義
resubmit_type

再送信のタイプ: SOURCETRANSFER_INSTANCETARGETまたはTARGET_INSTANCE

TARGETでは、ファイルは前処理なしで配信されます。TARGET_INSTANCEでは、配信前に任意の処理が呼び出されます。

instance_ids

カンマ区切りのインスタンスID。

ソース、転送またはターゲット・レポートの「拡張」セクションを開くと、インスタンスIDが表示されます。これらのレポートの詳細は、Oracle Managed File Transferの使用のソース、転送およびターゲットのレポートの解釈に関する項を参照してください。

comment

再送信の理由を説明する文字列。

5.6.3.3

次の例では、インスタンスID 3D48B12B-295A-4F52-A8EE-BD1CC1A20246SOURCEを再送信し、その理由を示します。

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

5.6.4 resumeTransfer

コマンド・カテゴリ: MFT転送管理コマンド

WLSTでの使用: オンラインまたはオフライン

5.6.4.1 説明

一時停止している転送を再開します。サポートされない操作の場合は、WLSTExceptionを返します。

5.6.4.2 構文

resumeTransfer(instance_id, comment)
resXfr(instance_id, comment)
引数 定義
instance_id

転送用のターゲット・インスタンスID。

ターゲット・レポートの「拡張」セクションを開くと、インスタンスIDが表示されます。ターゲット・レポートの詳細は、Oracle Managed File Transferの使用のソース、転送およびターゲットのレポートの解釈に関する項を参照してください。

comment

再開の理由を説明する文字列。

5.6.4.3

次の例では、ターゲット・インスタンスID 240C93AD-5401-483B-8182-274FA0705DF1の転送を再開し、その理由を示します。

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

5.7 MFT埋込みサーバー・コマンド

埋込みFTPおよびsFTPサーバーを管理するには、表5-7に示されたMFT WLST埋込みサーバー・コマンドを使用します。


表5-7 MFT埋込みサーバーWLSTコマンド

使用するコマンド 用途 使用するWLST

ConfigureHomeDirまたはconfHmDir

埋込みサーバーにホーム・ディレクトリを割り当てます。

オンラインまたはオフライン

grantPermissionToDirectoryまたはgrPermDir

埋込みサーバー・ディレクトリに対する権限を付与します。

オンラインまたはオフライン

listAllPermissionsまたはlsPerms

指定されたプリンシパルとサーバー・タイプに使用できるすべての権限のリストを返します。

オンラインまたはオフライン

revokePermissionForDirectoryまたはrevPermDir

埋込みサーバー・ディレクトリの権限を取り消します。

オンラインまたはオフライン

startEmbeddedServerまたはstartES

停止された埋込みFTPまたはsFTPサーバーを起動します。

オンラインまたはオフライン

stopEmbeddedServerまたはstopES

実行している埋込みFTPまたはsFTPサーバーを停止します。

オンラインまたはオフライン

updatePortsまたはupdPorts

埋込みFTPまたはsFTPサーバーのポートを更新します。

オンラインまたはオフライン


5.7.1 ConfigureHomeDir

コマンド・カテゴリ: MFT埋込みサーバー・コマンド

WLSTでの使用: オンラインまたはオフライン

5.7.1.1 説明

指定されたディレクトリをホーム・ディレクトリとしてユーザーに割り当てます。そのユーザーが埋込みサーバーにログインしたときの作業ディレクトリとなります。

5.7.1.2 構文

configureHomeDir(directory_path, user_name)
引数 定義

directory_path

埋込みサーバーのルートから開始する任意の有効なパス。

user_name

WebLogicユーザーID

5.7.1.3

次の例では、ディレクトリdir1を"user1"という名前のユーザーのホーム・ディレクトリとして割り当てます。

configureHomeDir("/dir1","user1")

5.7.2 grantPermissionToDirectory

コマンド・カテゴリ: MFT埋込みサーバー・コマンド

WLSTでの使用: オンラインまたはオフライン

5.7.2.1 説明

埋込みサーバー・ディレクトリに対する権限を付与します。埋込みサーバー上の既存のディレクトリに対する権限のセットをユーザーやグループに割り当てることができます。

5.7.2.2 構文

grantPermissionToDirectory(directory_path, principal_name, principal_type, permissions, server_type, include_subfolder)
引数 定義

directory_path

埋込みサーバーのルートから開始する任意の有効なパス

principal_name

エンタープライズ・ユーザー、グループまたはアプリケーション・ロールの名前。

principal_type

次のうちの1つ。

  • USER

  • GROUP

  • APPLICATION_ROLE

permissions

次の権限のカンマ区切りのリスト

  • READ

  • WRITE

  • LIST

  • DELETE

server_type

FTPまたはSFTP

include_subfolder

trueまたはfalse

5.7.2.3

次の例では、FTPサーバーのユーザー"weblogic"に対して、ディレクトリ/orders (およびサブディレクトリ)への読取り、書込み、リストおよび削除権限を割り当てます。

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

5.7.3 listAllPermissions

コマンド・カテゴリ: MFT埋込みサーバー・コマンド

WLSTでの使用: オンラインまたはオフライン

5.7.3.1 説明

指定されたプリンシパルとサーバー・タイプに使用できるすべての権限のリストを返します。サーバー・タイプはFTPまたはSFTPです。

5.7.3.2 構文

listAllPermissions(principal_name,server_type)
引数 定義

principal_name

エンタープライズ・ユーザー、グループまたはアプリケーション・ロールの名前。

server_type

FTPまたはSFTP

5.7.3.3

次の例では、FTPサーバーの"weblogic"というプリンシパルに対するすべての権限をリストします。

listAllPermissions("weblogic","FTP"

5.7.4 revokePermissionForDirectory

コマンド・カテゴリ: MFT埋込みサーバー・コマンド

WLSTでの使用: オンラインまたはオフライン

5.7.4.1 説明

埋込みサーバー・ディレクトリに対する権限のセットを取り消します。

5.7.4.2 構文

revokePermissionForDirectory(directory_path, principal_name, principal_type, permissions, server_type, include_subfolder)
引数 定義

directory_path

埋込みサーバーのルートから開始する任意の有効なパス

principal_name

エンタープライズ・ユーザー、グループまたはアプリケーション・ロールの名前。

principal_type

次のうちの1つ。

  • USER

  • GROUP

  • APPLICATION_ROLE

permissions

次の権限のカンマ区切りのリスト

  • READ

  • WRITE

  • LIST

  • DELETE

server_type

FTPまたはSFTP

include_subfolder

trueまたはfalse

5.7.4.3

次の例では、FTPサーバーのユーザー"weblogic"に対して、ディレクトリ/orders (およびサブディレクトリ)からの読取り、書込み、リストおよび削除権限を取り消します。

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

5.7.5 startEmbeddedServer

コマンド・カテゴリ: MFT埋込みサーバー・コマンド

WLSTでの使用: オンラインまたはオフライン

5.7.5.1 説明

停止している埋込みFTP、FTPS (FTP over SSL)またはsFTP (SSH-FTP)サーバーを起動します。サポートされない操作の場合は、WLSTExceptionを返します。

5.7.5.2 構文

startEmbeddedServer(server_type)
startES(server_type)
引数 定義
server_type

埋込みサーバーのタイプ: FTPFTPSまたはSFTP

5.7.5.3

次の例では、埋込みFTPサーバーを起動します。

startEmbeddedServer('FTP')

5.7.6 stopEmbeddedServer

コマンド・カテゴリ: MFT埋込みサーバー・コマンド

WLSTでの使用: オンラインまたはオフライン

5.7.6.1 説明

実行中の埋込みFTP、FTPS (FTP over SSL)またはsFTP (SSH-FTP)サーバーを停止します。サポートされない操作の場合は、WLSTExceptionを返します。

5.7.6.2 構文

stopEmbeddedServer(server_type)
stopES(server_type)
引数 定義
server_type

埋込みサーバーのタイプ: FTPFTPSまたはSFTP

5.7.6.3

次の例では、埋込みFTPサーバーを停止します。

stopEmbeddedServer('FTP')

5.7.7 updatePorts

コマンド・カテゴリ: MFT埋込みサーバー・コマンド

WLSTでの使用: オンラインまたはオフライン

5.7.7.1 説明

埋込みFTP、FTPS (FTP over SSL)またはsFTP (SSH-FTP)サーバーのポートを更新します。埋込みサーバーは、MFT専用のOracle WebLogic Server管理対象サーバーのサービスの1つです。サポートされない操作の場合は、WLSTExceptionを返します。

5.7.7.2 構文

updatePorts(server_instance, service, port)
updPorts(server_instance, service, port)
引数 定義
server_instance

MFT専用のOracle WebLogic Server管理対象サーバーの名前。

service

サービス(埋込みサーバーのタイプ): FTPFTPSまたはSFTP

port

ポート番号。

5.7.7.3

次の例では、埋込みFTPサーバーのポートを更新します。

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

5.8 MFTコールアウト・コマンド

カスタム・コールアウトを管理するには、表5-8に示されたMFT WLSTコールアウト・コマンドを使用します。


表5-8 MFTコールアウトWLSTコマンド

使用するコマンド 用途 使用するWLST

createCalloutsまたはcrtCalls

コールアウトを定義するXMLファイルに基づいてコールアウトを作成します。

オンラインまたはオフライン

deleteCalloutまたはdelCalls

コールアウトを削除します。

オンラインまたはオフライン

listCalloutsまたはlsCalls

コールアウトのリストを返します。

オンラインまたはオフライン

updateCalloutsまたはupdCalls

コールアウトを定義するXMLファイルに基づいて、同じ名前のコールアウトを更新します。

オンラインまたはオフライン


5.8.1 createCallouts

コマンド・カテゴリ: MFTコールアウト・コマンド

WLSTでの使用: オンラインまたはオフライン

5.8.1.1 説明

コールアウトを定義するXMLファイルに基づいてコールアウトを作成します。サポートされない操作の場合は、WLSTExceptionを返します。

コールアウトの説明および例は、Oracle Managed File Transferの使用のカスタム・コールアウトでの転送の処理に関する項を参照してください。

5.8.1.2 構文

createCallouts(def_file_path)
crtCalls(def_file_path)
引数 定義
def_file_path

コールアウト定義XMLファイルへのフルパス。

5.8.1.3

次の例では、/tmp/CalloutDefn.xmlという名前の定義ファイルに基づいてコールアウトを作成します。

createCallouts('/tmp/CalloutDefn.xml')

5.8.2 deleteCallout

コマンド・カテゴリ: MFTコールアウト・コマンド

WLSTでの使用: オンラインまたはオフライン

5.8.2.1 説明

コールアウトを削除します。サポートされない操作の場合は、WLSTExceptionを返します。

5.8.2.2 構文

deleteCallout(callout_name)
delCalls(callout_name)

引数 定義
callout_name

コールアウト名。


5.8.2.3

次の例では、NotifyTransferCompleteという名前のコールアウトを削除します。

deleteCallout('NotifyTransferComplete')

5.8.3 listCallouts

コマンド・カテゴリ: MFTコールアウト・コマンド

WLSTでの使用: オンラインまたはオフライン

5.8.3.1 説明

コールアウトのリストを返します。サポートされない操作の場合は、WLSTExceptionを返します。

5.8.3.2 構文

listCallouts()
lsCalls()

5.8.3.3

次の例では、コールアウトをリストします。

listCallouts()

5.8.4 updateCallouts

コマンド・カテゴリ: MFTコールアウト・コマンド

WLSTでの使用: オンラインまたはオフライン

5.8.4.1 説明

コールアウトを定義するXMLファイルに基づいて、同じ名前のコールアウトを更新します。サポートされない操作の場合は、WLSTExceptionを返します。

注意:

既存のコールアウトのパラメータは追加、削除または変更できません。

5.8.4.2 構文

updateCallouts(def_file_path)
updCalls(def_file_path)
引数 定義
def_file_path

コールアウト定義XMLファイルへのフルパス。

5.8.4.3

次の例では、/tmp/CalloutDefn.xmlという名前の定義ファイルに基づいてコールアウトを更新します。

updateCallouts('/tmp/CalloutDefn.xml')

5.9 MFTイベント通知コマンド

イベントの連絡先通知を管理するには、表5-9に示されたMFT WLSTイベント通知コマンドを使用します。


表5-9 MFT連絡先WLSTコマンド

使用するコマンド 用途 使用するWLST

addContactToNotificationまたはaddContNote

特定のイベント通知に連絡先を追加します。

オンラインまたはオフライン

createContactまたはCrtCont

イベント通知の連絡先を作成します。

オンラインまたはオフライン

deleteContactまたはdelCont

連絡先を削除します。

オンラインまたはオフライン

listContactsまたはlsConts

連絡先のリストを返します。

オンラインまたはオフライン

removeContactFromNotificationまたはremContNote

特定のイベント通知から連絡先を削除します。

オンラインまたはオフライン

updateEventまたはupdEvt

特定のイベント通知を有効または無効にします。

オンラインまたはオフライン


5.9.1 addContactToNotification

コマンド・カテゴリ: MFT連絡先コマンド

WLSTでの使用: オンラインまたはオフライン

5.9.1.1 説明

特定のイベント通知に連絡先を追加します。サポートされない操作の場合は、WLSTExceptionを返します。

5.9.1.2 構文

addContactToNotification(event, contact_type, value)
addContNote(event, contact_type, value)
引数 定義
event

イベント: RUNTIME_ERROR_EVENTDELETE_ARTIFACT_EVENTDEPLOY_ARTIFACT_EVENTEXPORT_IMPORT_EVENTPURGE_EVENTまたはARCHIVE_RESTORE_EVENT

contact_type

連絡先タイプ EMAILPHONEFAXまたはSMS

value

電子メール・アドレスまたは電話番号。

5.9.1.3

次の例では、EMAIL連絡先jane.doe@example.comRUNTIME_ERROR_EVENT通知に追加します。

addContactToNotification('RUNTIME_ERROR_EVENT', 'EMAIL', 'jane.doe@example.com')

5.9.2 createContact

コマンド・カテゴリ: MFT連絡先コマンド

WLSTでの使用: オンラインまたはオフライン

5.9.2.1 説明

イベント通知の連絡先を作成します。サポートされない操作の場合は、WLSTExceptionを返します。

電子メール・ドライバの構成方法の詳細は、Oracle Managed File Transferの使用の通知のための電子メール・ドライバの構成に関する項を参照してください。SMSドライバの構成方法の詳細は、Oracle Managed File Transferの使用の通知のためのSMSドライバの構成に関する項を参照してください。

注意:

電話およびFAXの通知は、このリリースのOracle Managed File Transferではサポートされていません。

5.9.2.2 構文

createContact(contact_type, value)
crtCont(contact_type, value)
引数 定義
contact_type

連絡先タイプ EMAILPHONEFAXまたはSMS

value

電子メール・アドレスまたは電話番号。

5.9.2.3

次の例では、電子メール・アドレスjane.doe@example.comに基づいて連絡先を作成します。

createContact('EMAIL', 'jane.doe@example.com')

5.9.3 deleteContact

コマンド・カテゴリ: MFT連絡先コマンド

WLSTでの使用: オンラインまたはオフライン

5.9.3.1 説明

連絡先を削除します。サポートされない操作の場合は、WLSTExceptionを返します。

5.9.3.2 構文

deleteContact(contact_type, value)
delCont(contact_type, value)
引数 定義
contact_type

連絡先タイプ EMAILPHONEFAXまたはSMS

value

電子メール・アドレスまたは電話番号。

5.9.3.3

次の例では、電子メール・アドレスjane.doe@example.comに基づいて連絡先を削除します。

deleteContact('EMAIL', 'jane.doe@example.com')

5.9.4 listContacts

コマンド・カテゴリ: MFT連絡先コマンド

WLSTでの使用: オンラインまたはオフライン

5.9.4.1 説明

連絡先のリストを返します。サポートされない操作の場合は、WLSTExceptionを返します。

5.9.4.2 構文

listContacts(contact_type)
lsConts(contact_type)
引数 定義
contact_type

連絡先タイプ EMAILPHONEFAXまたはSMS

5.9.4.3

次の例では、電子メール連絡先をリストします。

listContacts('EMAIL')

5.9.5 removeContactFromNotification

コマンド・カテゴリ: MFT連絡先コマンド

WLSTでの使用: オンラインまたはオフライン

5.9.5.1 説明

特定のイベント通知から連絡先を削除します。サポートされない操作の場合は、WLSTExceptionを返します。

イベントから最後の連絡先を削除すると、イベントは無効にされます。ただし、その逆はありません。イベントに最初の連絡先を追加する際、イベントは自動的に有効にされません。イベントは、updateEventコマンドを使用して有効にしてください。

5.9.5.2 構文

removeContactFromNotification(event, contact_type, value)
remContNote(event, contact_type, value)
引数 定義
event

イベント: RUNTIME_ERROR_EVENTDELETE_ARTIFACT_EVENTDEPLOY_ARTIFACT_EVENTまたはEXPORT_IMPORT_EVENT

contact_type

連絡先タイプ EMAILPHONEFAXまたはSMS

value

電子メール・アドレスまたは電話番号。

5.9.5.3

次の例では、EMAIL連絡先jane.doe@example.comRUNTIME_ERROR_EVENT通知から削除します。

removeContactFromNotification('RUNTIME_ERROR_EVENT', 'EMAIL', 'jane.doe@example.com')

5.9.6 updateEvent

コマンド・カテゴリ: MFT連絡先コマンド

WLSTでの使用: オンラインまたはオフライン

5.9.6.1 説明

特定のイベント通知を有効または無効にします。イベント通知はデフォルトで無効にされています。サポートされない操作の場合は、WLSTExceptionを返します。

5.9.6.2 構文

updateEvent(event, enabled)
updEvt(event, enabled)

引数 定義
event

イベント: RUNTIME_ERROR_EVENTDELETE_ARTIFACT_EVENTDEPLOY_ARTIFACT_EVENTまたはEXPORT_IMPORT_EVENT

enabled

有効化: TRUEまたはFALSE


5.9.6.3

次の例では、DELETE_ARTIFACT_EVENT通知を無効にします。

updateEvent('DELETE_ARTIFACT_EVENT', 'FALSE')

5.10 MFTアーカイブおよび復元コマンド

ステータスや日付範囲などの基準に基づいてランタイム・インスタンスまたはファイル・システム・データをアーカイブおよび復元するには、表5-10に示されたMFTアーカイブおよび復元コマンドを使用します。


表5-10 MFTアーカイブおよび復元WLSTコマンド

使用するコマンド 用途 使用するWLST

archiveInstanceDataまたはarcData

指定された基準に基づいてランタイム・インスタンスをアーカイブします。

オンラインまたはオフライン

restoreInstanceDataまたはresData

アーカイブ済のランタイム・インスタンスを復元します。

オンラインまたはオフライン

archivePayloadsまたはarcPLs

指定された基準に基づいてランタイム・インスタンス・データに対応するファイル・システム・データをアーカイブします。

オンラインまたはオフライン

restorePayloadsByNameまたはresPLbyN

以前にアーカイブされたファイル・システム・データをzipファイル名で復元します。

オンラインまたはオフライン

restorePayloadsByPrefixまたはresPLbyP

以前にアーカイブされたファイル・システム・データをzipファイル名接頭辞で復元します。

オンラインまたはオフライン


5.10.1 archiveInstanceData

コマンド・カテゴリ: MFTアーカイブおよび復元コマンド

WLSTでの使用: オンラインまたはオフライン

5.10.1.1 説明

指定された基準に基づいてランタイム・インスタンスをアーカイブします。オプションで、ファイル・システム・データをアーカイブします。サポートされない操作の場合は、WLSTExceptionを返します。

このコマンドを実行する前に、次のSQLコマンドを使用して、データベース・サーバーにMFTアーカイブ・ディレクトリを作成する必要があります。

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

データベースおよびスキーマ所有者(MFT_STB)の詳細は、Managed File Transferのインストールと構成を参照してください。

5.10.1.2 構文

archiveInstanceData(arguments)
arcData(arguments)

引数 定義
archiveFileName

定義済のMFTアーカイブ・ディレクトリに保存されるランタイム・インスタンス・アーカイブ・ファイルの名前。デフォルトの拡張子は、.dmpです。これは必須の引数です。

startDate

形式dd-MM-yyyy H:m:s:Sのタイムスタンプ。デフォルトでは日付および時間は指定されていません。式はサポートされていません。

endDate

形式dd-MM-yyyy H:m:s:Sのタイムスタンプ。デフォルトは現在の日時です。式はサポートされていません。

batchId

前のarchiveInstanceDataコマンドの出力の中にある識別子です。デフォルトの入力は空文字列です。テスト済または失敗したarchiveInstanceDataを失敗の時点から再実行するか、archivePayloadsを実行するために使用します。

status

ステータス: すべてのステータスには*COMPLETEDにはCFAILEDにはFACTIVE (進行中)にはA。デフォルトはCです。複数のカンマ区切りのステータスを指定できます。

testMode

アーカイブすべきものをテストしますが、アーカイブはしません。TRUEまたはFALSE。デフォルトはTRUEです。そのため、ランタイム・インスタンスを実際にアーカイブするには、明示的にtestMode=FALSEに設定する必要があります。

comments

コメント文字列。デフォルトは空の文字列です。

runInSync

ただちに同期的に実行して戻る(TRUE)か、バックグラウンドで非同期的に実行し、他のWLSTコマンドの実行を可能にする(FALSE)かどうかです。デフォルトはFALSEです。

fsArchiveFolderPath

ペイロード・アーカイブ.zipファイルが保存されるフォルダへのパス。デフォルトは空文字列で、これはペイロードが何もアーカイブされないことを意味します。これは、ランタイム・インスタンス・アーカイブ・ファイルおよびMFTアーカイブ・ディレクトリからは独立しています。


5.10.1.3

次の例では、テスト・モード(何もアーカイブしない)で、ステータスがCOMPLETEDのすべてのインスタンスに対してバックグラウンド(実行中、WLSTコマンドをブロックしない)で実行し、インスタンスまたはペイロードがいくつアーカイブされるかなどの統計を提供します。

archiveInstanceData()

出力の例は次のとおりです。

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.

次の例では、2013年3月31日よりも前で、ステータスがCOMPLETEDのインスタンスに対してバックグラウンドでテスト・モードで実行し、アーカイブ統計を提供します。startDate引数が省略された場合、endDate引数に明示的にラベルを付ける必要があります。

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

次の例では、ステータスがCOMPLETEDの2013年2月1日から2013年3月31日までのインスタンスをファイルmft.dmpにアーカイブし、アーカイブ統計を提供します。startDateおよびendDate引数の両方が含まれる場合、ラベルは省略できます。

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

次の例では、ステータスがACTIVEまたはFAILEDの2013年2月1日から2013年3月31日までのインスタンスをファイルmft.dmpにアーカイブし、アーカイブ統計を提供します。runInSync='TRUE'が指定されるため、アーカイブがただちに発生し、完了するまでそれ以降のWLSTコマンドをブロックします。runFSArchive='TRUE'が指定されるため、ファイル・システム・データもアーカイブされます。

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')

次の例では、バッチID 546781のテスト済の失敗したアーカイブを、失敗の場所から実行します。

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

5.10.2 restoreInstanceData

コマンド・カテゴリ: MFTアーカイブおよび復元コマンド

WLSTでの使用: オンラインまたはオフライン

5.10.2.1 説明

アーカイブ済のランタイム・インスタンスを復元します。サポートされない操作の場合は、WLSTExceptionを返します。

5.10.2.2 構文

restoreInstanceData(arguments)
resData(arguments)
引数 定義
archiveFilePath

復元するMFTアーカイブ・ディレクトリにあるアーカイブ・ファイルの名前。このディレクトリの定義方法は、「archiveInstanceData」を参照してください。デフォルトの拡張子は、.dmpです。これは必須の引数です。

fileNamePrefix

対応するペイロード・アーカイブ・ファイルのファイル名接頭辞を識別する文字列で、通常はバッチIDです。archiveInstanceDataバッチIDのarchivePayloadsを先に実行させる必要があります。デフォルト値はありません。

fsFolderPath

対応するペイロード・アーカイブ・ファイルが格納されるディレクトリへのパスを識別する文字列です。デフォルト値はありません。

runInSync

ただちに同期的に実行して戻る(TRUE)か、バックグラウンドで非同期的に実行し、他のWLSTコマンドの実行を可能にする(FALSE)かどうかです。デフォルトはFALSEです。

5.10.2.3

次の例では、以前にarchiveInstanceDataコマンドによってアーカイブされたランタイム・インスタンス・データを復元します。対応するペイロード・アーカイブは/tmp/mft/546781.zipから復元されます。このコマンドは、バックグラウンドで実行します。

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

5.10.3 archivePayloads

コマンド・カテゴリ: MFTアーカイブおよび復元コマンド

WLSTでの使用: オンラインまたはオフライン

5.10.3.1 説明

指定された基準に基づいてランタイム・インスタンス・データに対応するファイル・システム・データをアーカイブします。サポートされない操作の場合は、WLSTExceptionを返します。

5.10.3.2 構文

archivePayloads(arguments)
arcPLs(arguments)
引数 定義
batchId

アーカイブ基準を識別する文字列。デフォルト値はありません。先にarchiveInstanceDataを実行してbatchIdを取得します。これは必須の引数です。

archivePath

batchId.zipアーカイブが保存されるディレクトリへのパス。このディレクトリは存在している必要があります。大規模なアーカイブをbatchId_n.zipという名前の複数のファイルに保存できます。これは必須の引数です。

runInSync

ただちに同期的に実行して戻る(TRUE)か、バックグラウンドで非同期的に実行し、他のWLSTコマンドの実行を可能にする(FALSE)かどうかです。デフォルトはFALSEです。

5.10.3.3 MBeanプロパティ

Enterprise Managerを使用してMBeanを設定する方法の詳細は、「MFT WLSTコマンドに対するシステムMBeanプロパティの設定」を参照してください。


プロパティ 定義
FS_ARCHIVE_MAX_SIZE 

アーカイブzipファイルのサイズ制限をMBで設定する文字列。デフォルト値はゼロで、無制限を設定します。

FS_ARCHIVE_MAX_FILES_PER_ZIP

アーカイブzipファイルに含めることができるファイル数の制限を設定する文字列。デフォルト値はゼロで、無制限を設定します。


5.10.3.4

次の例では、以前にarchiveInstanceDataコマンドによってアーカイブされたバッチID 546781のランタイム・インスタンス・データに対応するファイル・システム・データをアーカイブします。アーカイブは/tmp/mft/546781.zipに保存され、ただちに実行されます。

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

5.10.4 restorePayloadsByName

コマンド・カテゴリ: MFTアーカイブおよび復元コマンド

WLSTでの使用: オンラインまたはオフライン

5.10.4.1 説明

以前にアーカイブされたファイル・システム・データを復元します。サポートされない操作の場合は、WLSTExceptionを返します。

5.10.4.2 構文

restorePayloadsByName(arguments)
resPLbyN(arguments)
引数 定義
fileNames

復元する.zipファイルの名前を識別する文字列。デフォルト値はありません。これは必須の引数です。

.zipファイルの名前がバッチID以外の名前に変更されている場合、この引数のバッチIDのかわりに新しいファイル名を指定する必要があります。

複数のbatchId_n.zipまたはprefix_n.zipファイルで構成されるアーカイブには、かわりにrestorePayloadsByPrefixコマンドを使用できます。

folderPath

.zipアーカイブが保存されたディレクトリへのパス。これは必須の引数です。

runInSync

ただちに同期的に実行して戻る(TRUE)か、バックグラウンドで非同期的に実行し、他のWLSTコマンドの実行を可能にする(FALSE)かどうかです。デフォルトはFALSEです。

5.10.4.3 MBeanプロパティ

Enterprise Managerを使用してMBeanを設定する方法の詳細は、「MFT WLSTコマンドに対するシステムMBeanプロパティの設定」を参照してください。


プロパティ 定義
FS_RESTORE_OVERWRITE_EXISTING

復元で同じ名前のファイルを上書きするかどうかを決定する文字列。デフォルト値はTRUEです。


5.10.4.4

次の例では、以前にarchivePayloadsコマンドによってアーカイブされたバッチID 546781のランタイム・インスタンス・データに対応するファイル・システム・データを復元します。アーカイブは/tmp/mft/546781.zipから復元され、ただちに実行されます。

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

5.10.5 restorePayloadsByPrefix

コマンド・カテゴリ: MFTアーカイブおよび復元コマンド

WLSTでの使用: オンラインまたはオフライン

5.10.5.1 説明

以前にアーカイブされたファイル・システム・データを復元します。サポートされない操作の場合は、WLSTExceptionを返します。

5.10.5.2 構文

restorePayloadsByPrefix(arguments)
resPLbyP(arguments)
引数 定義
fileNamePrefix

復元する.zipファイルを識別する文字列で、通常はバッチIDです。デフォルト値はありません。先にarchivePayloadsを実行してbatchIdを取得します。これは必須の引数です。

.zipファイルの名前がバッチID以外の名前に変更されている場合、この引数のバッチIDのかわりに新しいファイル名を指定する必要があります。

1つのprefix_n.zipファイルの名前を変更した場合、_n部分を変更せずに、すべの名前を変更する必要があり、そうしない場合にはこのコマンドはアーカイブ全体を復元しません。

folderPath

.zipアーカイブが保存されたディレクトリへのパス。これは必須の引数です。

runInSync

ただちに同期的に実行して戻る(TRUE)か、バックグラウンドで非同期的に実行し、他のWLSTコマンドの実行を可能にする(FALSE)かどうかです。デフォルトはFALSEです。

5.10.5.3 MBeanプロパティ

Enterprise Managerを使用してMBeanを設定する方法の詳細は、「MFT WLSTコマンドに対するシステムMBeanプロパティの設定」を参照してください。


プロパティ 定義
FS_RESTORE_OVERWRITE_EXISTING

復元で同じ名前のファイルを上書きするかどうかを決定する文字列。デフォルト値はTRUEです。


5.10.5.4

次の例では、以前にarchivePayloadsコマンドによってアーカイブされたバッチID 546781のランタイム・インスタンス・データに対応するファイル・システム・データを復元します。アーカイブは/tmp/mft/546781.zipから復元され、ただちに実行されます。

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

5.11 MFTパージ・コマンド

ステータスや日付範囲などの基準に基づいてランタイム・インスタンスまたはファイル・システム・データをパージするには、表5-11に示されたMFTパージ・コマンドを使用します。


表5-11 MFTパージWLSTコマンド

使用するコマンド 用途 使用するWLST

purgeInstanceDataまたはprgData

指定された基準に基づいてランタイム・インスタンスをパージします。オプションで、ファイル・システム・データをパージします。

オンラインまたはオフライン

purgePayloadsまたはprgPLs

指定された基準に基づいてランタイム・インスタンス・データに対応するファイル・システム・データをパージします。

オンラインまたはオフライン


5.11.1 purgeInstanceData

コマンド・カテゴリ: MFTパージ・コマンド

WLSTでの使用: オンラインまたはオフライン

5.11.1.1 説明

指定された基準に基づいてランタイム・インスタンスをパージします。オプションで、ファイル・システム・データをパージします。サポートされない操作の場合は、WLSTExceptionを返します。

5.11.1.2 構文

purgeInstanceData(optional_arguments)
prgData(optional_arguments)
引数 定義
startDate

形式dd-MM-yyyy H:m:s:Sのタイムスタンプ。デフォルトでは日付および時間は指定されていません。式はサポートされていません。

endDate

形式dd-MM-yyyy H:m:s:Sのタイムスタンプ。デフォルトは現在の日時です。式はサポートされていません。

batchId

前のpurgeInstanceDataコマンドの出力の中にある識別子です。デフォルトの入力は空文字列です。テスト済または失敗したpurgeInstanceDataを失敗の時点から再実行するか、purgePayloadsを実行するために使用します。

status

ステータス: すべてのステータスには*COMPLETEDにはCFAILEDにはFACTIVE (進行中)にはA。デフォルトはCです。複数のカンマ区切りのステータスを指定できます。

testMode

パージすべきものをテストしますが、パージはしません。TRUEまたはFALSE。デフォルトはTRUEです。そのため、ランタイム・インスタンスを実際にパージするには、明示的にtestMode=FALSEに設定する必要があります。

comments

コメント文字列。デフォルトは空の文字列です。

runInSync

ただちに同期的に実行して戻る(TRUE)か、バックグラウンドで非同期的に実行し、他のWLSTコマンドの実行を可能にする(FALSE)かどうかです。デフォルトはFALSEです。

runPayloadPurge

ランタイム・インスタンス・データに対応するファイル・システム・データもパージします。TRUEまたはFALSE。デフォルトはFALSEです。ファイル・システム・データを個別にパージするには、purgePayloadsを使用します。

5.11.1.3

次の例では、テスト・モード(何もパージしない)で、ステータスがCOMPLETEDのすべてのインスタンスに対してバックグラウンド(実行中、WLSTコマンドをブロックしない)で実行し、インスタンスまたはペイロードがいくつパージされるかなどの統計を提供します。

purgeInstanceData()

出力の例は次のとおりです。

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.

次の例では、テスト・モードで、ステータスがCOMPLETEDの2013年5月31日よりも前のインスタンスに対してバックグラウンドで実行し、パージ統計を提供します。startDate引数が省略された場合、endDate引数に明示的にラベルを付ける必要があります。

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

次の例では、ステータスがCOMPLETEDの2013年2月1日から2013年3月31日までのインスタンスをパージし、パージ統計を提供します。startDateおよびendDate引数の両方が含まれる場合、ラベルは省略できます。

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

次の例では、ステータスがACTIVEまたはFAILEDの2013年2月1日から2013年3月31日までのインスタンスをパージし、パージ統計を提供します。runInSync='TRUE'が指定されるため、パージがただちに発生し、完了するまでそれ以降のWLSTコマンドをブロックします。runPayloadPurge='TRUE'が指定されるため、ファイル・システム・データもパージされます。

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

次の例では、バッチID 546781のテスト済の失敗したパージを、失敗の場所から実行します。

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

5.11.2 purgePayloads

コマンド・カテゴリ: MFTパージ・コマンド

WLSTでの使用: オンラインまたはオフライン

5.11.2.1 説明

指定された基準に基づいてランタイム・インスタンス・データに対応するファイル・システム・データをパージします。サポートされない操作の場合は、WLSTExceptionを返します。

5.11.2.2 構文

purgePayloads(arguments)
prgPLs(arguments)
引数 定義
batchId

パージ基準を識別する文字列。デフォルト値はありません。先にpurgeInstanceDataを実行してbatchIdを取得します。

detailedAudit

各パージ済ファイルの監査するかどうかです。TRUEまたはFALSE。デフォルトはTRUEです。

runInSync

ただちに同期的に実行して戻る(TRUE)か、バックグラウンドで非同期的に実行し、他のWLSTコマンドの実行を可能にする(FALSE)かどうかです。デフォルトはFALSEです。

5.11.2.3 MBeanプロパティ

Enterprise Managerを使用してMBeanを設定する方法の詳細は、「MFT WLSTコマンドに対するシステムMBeanプロパティの設定」を参照してください。


プロパティ 定義
FS_PURGE_BATCH_SIZE

ペイロード・パスを読み取るためのバッチ・サイズを決定する文字列。purgePayloadsコマンドは、メモリー不足を防ぐため、データベースからペイロード・パスを数回に分けて読み取ります。デフォルト値は、5000です。

FS_PURGE_TEMP_TABLES_LIFE

ペイロード・パージの後に削除される一時表の最小経過時間を日数で決定する文字列。デフォルト値は30です。

FS_PURGE_THREAD_COUNT

ペイロード・パージの実行に使用されるノードごとのスレッド数を決定する文字列。デフォルト値は1です。


5.11.2.4

次の例では、以前にpurgeInstanceDataコマンドによってパージされたバッチID 546781のランタイム・インスタンス・データに対応するファイル・システム・データをパージします。パージされたファイルの詳細な監査が行われ、このパージはバックグラウンドで実行します。

purgePayloads(batchId='546781')

次の例では、以前にpurgeInstanceDataコマンドによってパージされたバッチID 546781のランタイム・インスタンス・データに対応するファイル・システム・データをパージします。パージされたファイルの詳細な監査は行われず、パージはバックグラウンドで実行します。

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

次の例では、以前にpurgeInstanceDataコマンドによってパージされたバッチID 546781のランタイム・インスタンス・データに対応するファイル・システム・データをパージします。パージされたファイルの詳細な監査が行われ、パージはただちに発生します。

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

5.12 MFT WLSTコマンドのシステムMBeanプロパティの設定

一部のMFT WLSTコマンドには、実行する操作を調整するために設定できる関連プロパティがあります。

このプロセスの手順は次のとおりです。

  1. Oracle Enterprise Managerコンソールにログインします。

  2. ターゲット・ナビゲーション・ペインで、「WebLogicドメイン」ノードを開きます。

  3. Oracle Managed File Transfer専用のOracle WebLogic Server管理対象サーバーがインストールされているドメインを選択します。

    たとえば、ドメインはsoainfraまたはbase_domainです。

  4. ドメインを右クリックし、「システムMBeanブラウザ」を選択します。

  5. 「検索」アイコンをクリックします。

  6. 「MBean名」テキスト・ボックスにMFTConfigと入力します。[Enter]を押します。

    「アプリケーション定義のMBeans: MFTConfig: mft」ページが表示されます。

  7. 「操作」タブをクリックします。

  8. 「addProperty」をクリックします。

    「操作: addProperty」ページが表示されます。

  9. 「キー」テキスト・ボックスにプロパティ名を入力します。「値」テキスト・ボックスにプロパティ値を入力します。コメントの入力はオプションです。「呼出し」をクリックします。

  10. プロパティが追加されたことを確認するには:

    1. 「戻る」をクリックします。

    2. 「属性」タブをクリックします。

    3. 「プロパティ」をクリックします。

      「属性: プロパティ」ページが表示されます。追加したプロパティが一覧表示されるはずです。