1. Oracle Cloud Infrastructure Object Storage Classicのコマンドライン・リファレンス
  2. FTM CLIコマンドの一般的な構文
機械翻訳について

2 FTM CLIコマンドの一般的な構文

以下は、「Oracle Cloud Infrastructure Object Storage Classic File Transfer Managerコマンドライン・インタフェース」(FTM CLI)のコマンドのgeneral構文です: 

java -jar ftmcli.jar command [command_specific_options] target [general_CLI_command_options] -P rest_endpoint -U user

環境変数または構成ファイルを使用して認証パラメータが設定されている場合、FTM CLIコマンドの簡略コマンドは次のようになります。 

java -jar ftmcli.jar command [command_specific_options] target [general_CLI_command_options]

注意:

  • このマニュアルでは、すべてのコマンドを簡略構文で説明しています。 ただし、認証パラメータの設定に選択した方式に応じて、適切な構文を使用してください。 認証を参照してください。

  • FTM CLI 2.3以前の場合は、次のコマンドのgeneral構文を使用します。 

    java -jar ftmcli.jar command [command_specific_options] target [general_CLI_command_options] -U user -A auth_url -S service -I identity_domain

    • user、auth_url、service、およびidentity_domainについては、「CLIコマンド・オプション」を参照してください。 オプションauth_url、service、およびidentity_domainは、FTM CLI 2.4から非推奨です。 REST Endpoint URLパラメータを使用してストレージ・アカウントにアクセスするための認証を取得し、認証URL、サービス名、アイデンティティ・ドメインなどの非推奨のパラメータを取得することはお勧めしません。

重要:

  • FTM CLI 2.3以前の場合、JRE 9を使用していて、以下のいずれかのシナリオが該当する場合は、

    • コマンドで-save-auth-keyパラメータを使用してパスワードを保存しています。

    • このコマンドは、ftmcliKeystore ファイルに格納されている暗号化されたパスワードにアクセスします。

    次のgeneralコマンド構文を使用します。
    java --add-modules java.xml.bind -jar ftmcli.jar command [command_specific_options] target [general_CLI_command_options] -U user -A auth_url -S service -I identity_domain
    または次のsimplifiedコマンド構文を使用します。
    java --add-modules java.xml.bind -jar ftmcli.jar command [command_specific_options] target [general_CLI_command_options]
  • JRE 8を使用している場合、FTM CLI 2.4のパフォーマンスを向上させるには、GCMを無効にします。
    1. java.securityファイルを次の行で作成します。
      jdk.tls.disabledAlgorithms=SSLv3,GCM
    2. 次のコマンドを使用してJavaプロセスを開始します。
      java -Djava.security.properties=/path/to/my/java.security -jar ftmcli.jar command [command_specific_options] target [general_CLI_command_options] -P rest_endpoint -U user

CLIコマンド・オプション

認証

次の表は、認証に使用できる「Oracle Cloud Infrastructure Object Storage Classic File Transfer Managerコマンドライン・インタフェース」(FTM CLI)コマンド・オプションについて説明しています。

オプション 説明 必須かどうか

-P rest_endpoint

--rest-endpoint rest_endpoint

 ストレージ・アカウントのRESTエンドポイントまたはRESTエンドポイント(永続的)。 「RESTエンドポイントURL」を参照してください。

FTM_REST_ENDPOINT環境変数を構成しない場合、または構成ファイルでrest-endpointパラメータを構成していない場合は必須です。

-U user

--user user

FTM CLI 2.4を使用している場合は、ストレージ・アカウントにアクセスするためのユーザー名です。 アカウント情報の取得を参照してください。

FTM CLI 2.3以前を使用している場合、これはユーザー名と「REST APIエンドポイントURL」を使用して作成したユーザー・パラメータです。 「ユーザー・パラメータの作成」を参照してください。

注意:

「Oracle Cloud Infrastructure Classicコンソール」に適切なロールがあること。 「必要なロールの取得」を参照してください。

FTM_USER環境変数を設定していない場合、または構成ファイルでuserパラメータを設定していない場合は必須です。

-A auth_url

--auth-url auth_url

Oracle Cloud Infrastructure Object Storage ClassicインスタンスのRESTエンドポイントURLから派生した認証URL。 「RESTエンドポイントURL」を参照してください。

FTM_AUTH_URL環境変数を設定していない場合、または構成ファイルでauth-urlパラメータを設定していない場合は必須です。

(FTM CLI 2.4では推奨されません)

-S service

--service service

Oracle Cloudのサービスの名前。 「RESTエンドポイントURL」を参照してください。

FTM_SERVICE環境変数を設定していない場合、または構成ファイルでserviceパラメータを設定していない場合は必須です。

(FTM CLI 2.4では推奨されません)

-I identity_domain

--identity-domain identity_domain

Oracle Cloud Infrastructure Object Storage Classicインスタンスのアイデンティティ・ドメイン。 アイデンティティ・ドメインを調べるには、「アイデンティティ・ドメイン名、ユーザー名、およびパスワード」を参照してください。

FTM_IDOMAIN環境変数を設定していない場合、または構成ファイルでidentity-domainパラメータを設定していない場合は必須です。

(FTM CLI 2.4では推奨されません)

--save-auth-key

入力したパスワードが暗号化され、暗号化されたパスワードがftmcliKeystoreファイルにローカルに保存されます。

次回のコマンドの実行時に、FTM CLIは、前に保存したパスワードを復号化して使用します。 パスワードの入力を求められなくなります。

警告:

- ftmcliKeystoreファイルは編集、名前変更、移動または削除しないでください。

- 保存したパスワードを復号化するためのキーは、ftmcli.propertiesファイルにauth-keyパラメータとして保存されます。 そのパラメータは削除または編集しないでください。

FTM CLIを初めて使用する場合にのみ必須です。

注意:

REST Endpoint URLパラメータを使用してストレージ・アカウントにアクセスするための認証を取得し、認証URL、サービス名、アイデンティティ・ドメインなどの非推奨のパラメータを取得することはお勧めしません。

例:

  • ストレージ・アカウントのRESTエンドポイントがhttps://acme.storage.oraclecloud.com/v1/Storage-acmeに似ており、FTM CLI 2.4を使用している場合、listコマンドは次のようになります。 

    java -jar ftmcli.jar list -P https://acme.storage.oraclecloud.com/v1/Storage-acme -U jack.jones@example.com --save-auth-key

  • ストレージ・アカウントのRESTエンドポイントがhttps://storage-7b16fede61e1417ab83eb52e06f0e365.storage.oraclecloud.com/v1/Storage-7b16fede61e1417ab83eb52e06f0e365に似ており、FTM CLI 2.4を使用している場合、listコマンドは次のようになります。 

    java -jar ftmcli.jar list -P https://storage-7b16fede61e1417ab83eb52e06f0e365.storage.oraclecloud.com/v1/Storage-7b16fede61e1417ab83eb52e06f0e365 -U jack.jones@example.com --save-auth-key

  • ストレージ・アカウントのRESTエンドポイントがhttps://acme.storage.oraclecloud.com/v1/Storage-acmeに似ており、FTM CLI 2.3以前を使用している場合、listコマンドは次のようになります。 

    java -jar ftmcli.jar list -U Storage-acme:jack.jones@example.com -A https://acme.storage.oraclecloud.com -S Storage -I acme --save-auth-key

一般

次の表では、一般的なCLIコマンド・オプションについて説明します。

オプション 説明

-d

--debug

デバッグ・モードでコマンドを実行する必要があることを示します。 このモードでの出力は非常に詳細です。 これには、FTM CLIコマンドの内部APIコールのリクエストとレスポンスの詳細が含まれます。 この出力は、問題のデバッグの際に役立つことがあります。この出力は、ftmcli.traceファイルで得られます。

-i

--silent

非詳細モードでコマンドを実行する必要があることを示します。

-v

--version

FTM CLIツールのバージョンを出力します。

例

java -jar ftmcli.jar -v

サンプル出力

Version 2.3.0

-h

--help

ヘルプ・メッセージを表示して、終了します。

例

java -jar ftmcli.jar -h

--properties-file /full/path/to/the/configuration/file

FTM CLIクライアントとは異なるディレクトリにある場合、またはftmcli.properties以外の名前を持つ場合は、構成ファイルの絶対パスと名前を指定します。

例

java -jar ftmcli.jar --properties-file /home/jack/temp/ftmcli.prop list

一般的なCLIコマンド・アクション

次の表は、FTM CLIコマンドを使用してOracle Cloud Infrastructure Object Storage Classicに対して実行できる一般的な操作を示しています。

アクション 説明

copy

オブジェクトをソース・コンテナからターゲット・コンテナにコピーします。

create-container

コンテナを作成します。

delete

コンテナまたはオブジェクトを削除します。

download

指定したオブジェクトをストレージ・アカウントのコンテナからローカル・ホストにダウンロードします。

archiveコンテナからオブジェクトをダウンロードする場合は、そのオブジェクトを先にリストアしておく必要があります。

list

指定したコンテナ内のオブジェクのリスト、またはストレージ・アカウント内のコンテナのリストを取得します。

restore

ストレージ・アカウントのarchiveコンテナ内の指定したオブジェクトをリストアします。

アーカイブされたオブジェクトは、リストした後でのみローカル・ホストにダウンロードできます。

upload

指定したオブジェクトをローカル・ホストからストレージ・アカウントのstandardコンテナまたはarchiveコンテナにアップロードします。 (アーカイブ・サポートはOracle Cloud at Customerでは利用できません)

describe

アカウント、コンテナ、またはオブジェクトのメタデータを取得します。

set

アカウント、コンテナ、またはオブジェクトのメタデータを設定します。

set-crp

コンテナのコンテナ・レベルのレプリケーション・ポリシーを設定します。