| Oracle® Fusion Middleware Oracle Managed File Transferの使用 12c リリース(12.2.1.2) E82801-03 |
|
 前 |
Oracle Managed File Transfer (MFT)の操作を実行するWLST (Oracle WebLogic Scripting Tool)コマンドの使用方法を示します。
この章の内容は次のとおりです。
MFTのWLSTコマンドの詳しい説明と例については、SOA Suite用WLSTコマンド・リファレンスのOracle Managed File TransferのカスタムWLSTコマンドに関する項を参照してください。
WLSTのコマンドを実行するには、あらかじめWLSTを起動してOracle MFT専用のOracle WebLogic Server管理対象サーバーに接続しておく必要があります。
このプロセスの手順は次のとおりです。
様々な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')
|
ソース、転送またはターゲットのアーティファクトのカンマ区切りリストをデプロイします。*はすべてを意味します。コメントは省略可能です。 |
|
createMftCredential(password, key) |
mftappの資格証明を作成します。資格証明を作成する必要があるパスワードと、資格証明のキーを入力します。 |
|
|
|
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('<ArtifactType>','<ArtifactName>',<Label>,'<ArchiveFilePath>',generateConfigPlan, longFormat)
|
デプロイ済のソース、転送またはターゲットのアーティファクトをZIPファイルにエクスポートします。「デプロイメント」タブの「デプロイメントの詳細の表示」を使用すると、 GenerateConfigPlan (オプション。デフォルトはfalse): mftConfig XMLを生成するかどうかを指定します。構成計画は、アーカイブ・ファイルが生成されるのと同じフォルダに生成されます。 LongFormat (オプション。デフォルトはfalse): "true"の場合は、config plan xmlに属性のほとんどが含まれます。それ以外の場合、構成プランXMLには主要な属性のみがリストされます。 |
|
|
isArtifactInMDS('TRANSFER|SOURCE|TARGET',
'artifact_name')
|
ソース、転送またはターゲットのアーティファクトがMDS (メタデータ・ストア)に存在するかどうかを調べて |
|
|
undeployArtifact('TRANSFER|SOURCE|TARGET',
'artifact_name', 'comment')
|
ソース、転送またはターゲットのアーティファクトを、構成から削除せずにアンデプロイします。コメントは省略可能です。 |
|
|
exportMetadata('<ArchiveFile>', generateConfigPlan, longFormat)
|
MFT構成全体(パスワードを除く)をZIPファイルにエクスポートします。WLSTにリモート接続している場合は、ZIPファイルはリモート・サーバー上に作成されます。 GenerateConfigPlan (オプション。デフォルトはfalse): mftConfig XMLを生成するかどうかを指定します。構成計画は、アーカイブ・ファイルが生成されるのと同じフォルダに生成されます。 LongFormat (オプション。デフォルトはfalse): "true"の場合は、config plan xmlに属性のほとんどが含まれます。それ以外の場合、構成プランXMLには主要な属性のみがリストされます。 |
|
|
exportTransferMetadata('<ArchiveFile>', '<TransferName>', generateConfigPlan, longFormat )
|
転送アーティファクトおよび関連するメタデータをZIPファイルにエクスポートします。WLSTにリモート接続している場合は、ZIPファイルはリモート・サーバー上に作成されます。 GenerateConfigPlan (オプション。デフォルトはfalse): mftConfig XMLを生成するかどうかを指定します。構成計画は、アーカイブ・ファイルが生成されるのと同じフォルダに生成されます。 LongFormat (オプション。デフォルトはfalse): "true"の場合は、config plan xmlに属性のほとんどが含まれます。それ以外の場合、構成プランXMLには主要な属性のみがリストされます。 |
|
|
importMetadata('<ArchiveFile>',<MftConfigPlanXML>, previewMode)
|
エクスポート済のMFT構成をZIPファイルからインポートします。 GenerateConfigPlan (オプション。デフォルトはfalse): mftConfig XMLを生成するかどうかを指定します。構成計画は、アーカイブ・ファイルが生成されるのと同じフォルダに生成されます。 |
|
|
resetMetadata('preserve_preferences')
|
MFT構成をリセットします。すべてのアーティファクトが削除され、すべての管理設定がデフォルト値にリセットされますが、省略可能な |
|
|
deleteCSFKey('SSH|PGP', 'PRIVATE|PUBLIC', 'alias')
|
鍵別名をMFTキーストアから削除します。 |
|
|
exportCSFKey('SSH|PGP', 'PRIVATE|PUBLIC',
'key_file_path')
|
鍵をMFTキーストアからキー・ファイルにエクスポートします。 |
|
|
generateKeys('SSH|PGP', 'password',
'key_file_path')
|
鍵を生成して1つ以上のキー・ファイルに保存します。鍵のタイプはRSAで、鍵のサイズは1024ビットです。秘密鍵のパスワードは省略可能です。 SSHの場合は、パスにキー・ファイル名が含まれている必要があります。 PGPの場合は、指定したパスの下に2つのファイルが生成されます。
|
|
|
importCSFKey('SSH|PGP', 'PRIVATE|PUBLIC', 'alias',
'key_file_path')
|
鍵をキー・ファイルからMFTキーストアにインポートして別名を作成します。 |
|
|
listCSFKeyAliases('SSH|PGP', 'PRIVATE|PUBLIC',
'alias')
|
MFTキーストア内の鍵別名のリストを返します。 |
|
|
updateCSFKey('SSH|PGP', 'PRIVATE|PUBLIC', 'alias',
'key_file_path')
|
鍵別名をMFTキーストアから削除して新しいキー・ファイルを作成します。 |
|
|
getSourceDeploymentHistory('source_name')
|
ソース・アーティファクトのデプロイメント履歴を返します。 |
|
|
getTargetDeploymentHistory('target_name')
|
ターゲット・アーティファクトのデプロイメント履歴を返します。 |
|
|
getTransferDeploymentHistory('transfer_name')
|
転送アーティファクトのデプロイメント履歴を返します。 |
|
|
getTransferInfo('transfer_name', 'label')
|
転送アーティファクトに関する情報を返します。「デプロイメント」タブの「デプロイメントの詳細の表示」を使用すると、 |
|
|
pauseTransfer('instance_id', 'comment')
|
進行中の転送を一時停止します。ターゲット・レポートの「拡張」セクションを開くと、インスタンスIDが表示されます。ターゲット・レポートの詳細は、「ソース、転送およびターゲットのレポートの解釈」を参照してください。コメントは省略可能です。 |
|
|
resubmit('resubmit_type', 'instance_ids',
'comment')
|
転送を再送信します。 |
|
|
resubmitMessages(<ResubmitType>, <state>, <artifactName>, <startDate>, <endDate>, <chunkSize>, <chunkDelay>, <ignoreIds>, <comments>, <previewMode>) |
転送のバルク再送信。ResubmitTypeは、再送信を呼び出した対象アーティファクトのタイプです。指定できる値はsource、transfer_instance、target、target_instanceです。状態 (オプション)は、「アクティブ」、「失敗」、「完了」のいずれかです。開始日/終了日を使用すると、指定された日付範囲で失敗したすべてのメッセージを再送信できます。コマンドをプレビュー・モードで実行すると、指定した基準で再送信されるメッセージの数がリストされます。 |
|
|
resumeTransfer('instance_id', 'comment')
|
一時停止している転送を再開します。ターゲット・レポートの「拡張」セクションを開くと、インスタンスIDが表示されます。ターゲット・レポートの詳細は、「ソース、転送およびターゲットのレポートの解釈」を参照してください。コメントは省略可能です。 |
|
|
configureHomeDir('directory_path', 'user_name')
|
指定されたディレクトリをホーム・ディレクトリとしてユーザーに割り当てます。そのユーザーが埋込みサーバーにログインしたときの作業ディレクトリとなります。 |
|
|
grantPermissionToDirectory('directory_path',
'principal_name', 'principal_type',
'permissions', 'server_type', 'include_subfolder')
|
埋込みサーバー・ディレクトリに対する権限を付与します。埋込みサーバー上の既存のディレクトリに対する権限のセットをユーザーやグループに割り当てることができます。 |
|
|
listAllPermissions(principalName,serverTypes) |
指定されたプリンシパルとサーバー・タイプに使用できるすべての権限のリストを返します。サーバー・タイプはFTPまたはsFTPです。次に例を示します。 wls:/mydomain/serverConfig> listAllPermissions("weblogic","FTP") |
|
|
createArtifacts('<xmlFilePath>',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', <transferNames>, <namesDelimiter>) |
ランタイム・インスタンスをパージします。引数はいずれも省略可能です。日付の形式は |
|
|
purgePayloads(batchId='batchId',
detailedAudit='TRUE|FALSE',
runInSync='FALSE|TRUE')
|
ランタイム・インスタンスに対応するペイロードをパージします。 |
|
|
createUserContact(<userName>,<deliveryChannel>) |
新しいユーザー連絡先を作成します。これは、イベント通知に使用できます。 deliveryChannel (オプション): Email/SMSに指定できる値。指定しない場合は、WebLogicユーザーで構成されているユーザー優先配信チャネルが使用されます。 |
|
|
createUserGroupContact(<userGroupName>,<deliveryChannel>) |
新しいユーザー・グループ連絡先を作成します。これは、イベント通知に使用できます。 deliveryChannel (オプション): Email/SMSに指定できる値。指定しない場合は、WebLogicユーザーで構成されているユーザー優先配信チャネルが使用されます。 |
|
|
addUserContactToNotification(<Event>, <userName>, <deliveryChannel>) |
通知イベントのためのユーザー連絡先を追加します。 イベント値: deliveryChannel (オプション): 指定できる値は「電子メール」/「SMS」です 注意: 内部連絡先を追加する前に、電子メール・アドレス/連絡先電話番号がユーザー設定にあることを確認してください。 |
|
|
addUserGroupContactToNotification(<Event>, <userGroupName>, <deliveryChannel>) |
通知イベントのためのグループ・ユーザー連絡先を追加します。 イベント値: deliveryChannel (オプション): 指定できる値は「電子メール」/「SMS」です |
|
|
deleteUserContact(<userName>,<deliveryChannel>) |
既存のユーザー連絡先を削除します。注意: 連絡先が使用されている(イベントに割り当てられている)場合、エラー・メッセージが表示されます。 |
|
|
deleteUserGroupContact(<userGroupName>,<deliveryChannel>) |
既存のユーザー・グループ連絡先を削除します。注意: 連絡先が使用されている(イベントに割り当てられている)場合、エラー・メッセージが表示されます。 |
|
|
removeUserContactFromNotification(<Event>, <userName>, <deliveryChannel>) |
通知イベントから、指定したユーザー連絡先を削除します。 イベント値: deliveryChannel (オプション): 指定できる値は「電子メール」/「SMS」です |
|
|
removeUserGroupContactFromNotification(<Event>, <userGroupName>, <deliveryChannel>) |
通知イベントから、指定したユーザー・グループ連絡先を削除します。 イベント値:
|
triggerEvent |
trgEvt |
triggerEvent('<sourceName>', '<properties>') |
JCA/OCS/RIDCソースに対してイベントをトリガーし、ファイル転送を開始します。 サポートされているパラメータ: |
updateTriggerEventStatus |
updTrgEvtSt |
updateTriggerEventStatus(<status>, <sourceName>, <eventSessionId>) |
指定したeventSessionIdのTriggerEventステータスが更新されます。
|
activatePurgeSchedule |
actPurgeSch |
activatePurgeSchedule(schedule_name) |
パージ・スケジュールをアクティブ化するために使用されます。アクティブ化するパージ・スケジュール名を指定します。デフォルトのscheduleNameは、デフォルトのパージ・スケジュールです。パージ・スケジュール名を指定しない場合、コマンドによってデフォルトのパージ・スケジュールがアクティブ化されます。このコマンドでアクティブ化できるパージ・スケジュールは1つだけです。 |
deactivatePurgeSchedule |
deactPurgeSch |
<scheduleName> |
パージ・スケジュールを非アクティブ化するために使用します。非アクティブ化するパージ・スケジュール名を指定します。デフォルトのscheduleNameは、デフォルトのパージ・スケジュールです。パージ・スケジュール名を指定しない場合、コマンドによってデフォルトのパージ・スケジュールが非アクティブ化されます。このコマンドで非アクティブ化できるパージ・スケジュールは1つだけです。 |
modifyPurgeSchedule |
modifyPurgeSch |
modifyPurgeSchedule(<startDate>, <endDate>, <scheduleTime>, <frequency>, <retentionPeriod>, <status>, <transferNames>, <namesDelimiter>, <include>, <comment>) |
既存のパージ・スケジュールを変更するために使用されます。
retentionPeriodの値はゼロ以上の数字、statusの値は「完了」または「失敗」(あるいはその両方)、transferNamesはインスタンスをパージする必要がある転送名、namesDelimiterの値はシングル・キャラクタ文字列、includeの値は「True」または「False」、commentの値は任意の文字列となります。 |
updateAppProperties |
updAppPrt |
updateAppProperties('<propertiesNameValuePair>', '<delimeter>')
|
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('<enableSFTP>', '<keyAlias>', '<privateKeyPassword>')
|
組込みSFTPサーバーを有効化または無効化するために使用されます。SFTPサーバーを有効化するには、オプションの秘密鍵のパスワードに加えて、SSH鍵の別名が必須です。鍵がパスワードで保護されていない場合は、秘密鍵のパスワードは不要です。無効化するには、鍵の別名もパスワードも不要です。サポートされているパラメータは次のとおりです: enableSFTP: SFTPを有効化/無効化するためのブール値、keyAlias: SSH秘密鍵の別名、privateKeyPassword: SSH秘密鍵のオプションのパスワード。 |
注意:
MFT WLSTコマンド・ショートカットは、MFT WLSTコマンドの簡潔な別名です。これを使用したい場合には、フル・コマンドのかわりに使用することもできます。フル・コマンド名を使用する場合とショートカット・コマンド名を使用する場合とでは、コマンド動作に違いはありません。
