1. Oracle Cloud Infrastructure Object Storage Classicのコマンドライン・リファレンス
  2. FTM CLIを使用するための準備
機械翻訳について

1 FTM CLIを使用するための準備

最初に「Oracle Cloud Infrastructure Object Storage Classic File Transfer Managerコマンドライン・インタフェース」(FTM CLI)をインストールする必要があります。認証メソッドの選択に応じて、構成ファイルまたはいくつかの環境変数を構成する必要があります。

内容は次のとおりです

システム要件とサポートされるプラットフォーム

サポートされるプラットフォーム

  • Oracle Linux 6.3以降

  • Oracle Linux 7.0以降

  • Microsoft Windows 7

  • Microsoft Windows 10

  • Microsoft Windows Server 2012

  • Ubuntu 14.04 LTS

  • Ubuntu 16.04 LTS

  • Mac OS X 10.7以降

  • Mac OS 10.12以降

JREの要件

次のいずれかのJREがインストールされていることを確認してください。

  • JRE 7

  • JRE 8

  • JRE 9

  • OpenJDK 7

  • OpenJDK 8

重要:

  • 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

アカウント情報の取得

アイデンティティ・ドメイン名、ユーザー名およびパスワード

Oracleがアカウントを作成すると、Oracle Cloud Infrastructure Object Storage Classicアカウントのユーザー名とパスワードを含むWelcomeメールが送信されます。 さらに、アカウントのタイプが「従来のアカウント」の場合、ウェルカム電子メールにはアイデンティティ・ドメインも含まれます。 あなたのアカウント・タイプを知るには、「Oracle Cloud Infrastructure Object Storage Classicの使用」の「Oracle Cloud Infrastructure Object Storage ClassicリソースのREST URLについて」を参照してください。

Oracleからのアカウント作成電子メールには、アイデンティティ・ドメインの名前、ユーザー名およびパスワードが含まれています。

この電子メールが見つからない場合や受信していない場合は、サービス管理者に問い合せてください。

RESTエンドポイントURL

ストレージ・アカウントのRESTエンドポイントURLを確認し、アカウント・タイプを知るには、「Oracle Cloud Infrastructure Object Storage Classicの使用」の「Oracle Cloud Infrastructure Object Storage ClassicリソースのREST URLについて」を参照してください。

アカウントのタイプに応じて、次のURLのようなRESTエンドポイントの一方または両方が表示されます。
REST Endpoint: https://acme.storage.oraclecloud.com/v1/Storage-acme
REST Endpoint (Permanent): https://storage-7b16fede61e1417ab83eb52e06f0e365.storage.oraclecloud.com/v1/Storage-7b16fede61e1417ab83eb52e06f0e365
ユースケースのためにFTM CLIで「RESTエンドポイント」または「RESTエンドポイント(永続的)」を使用する必要があるかどうかを判断するには、「Oracle Cloud Infrastructure Object Storage Classicの使用」の「クラウド・アカウントのRESTエンドポイントURLの検索」を参照してください。

注意:

  • 上記の例では、Storageがサービス名です。

  • FTM CLI 2.3以前では、認証URLパラメータには、APIバージョン/v1の前に表示されるRESTエンドポイントURLの一部のみを使用します。 つまり、認証URLパラメータの上記の例の「RESTエンドポイント(永続的)」または「RESTエンドポイント(永続的)」の「RESTエンドポイント」またはhttps://storage-7b16fede61e1417ab83eb52e06f0e365.storage.oraclecloud.comのhttps://acme.storage.oraclecloud.comを使用します。

userパラメータの作成

FTM CLI 2.3以前を使用している場合、Oracle Cloud Infrastructure Object Storage Classicにアクセスするための認証を取得するには、ユーザー名と「REST APIエンドポイントURL」を使用してuserパラメータを構成する必要があります。

  1. APIバージョンv1/の後にRESTエンドポイントURLの一部を取得します。

    たとえば、RESTエンドポイントURLがhttps://acme.storage.oraclecloud.com/v1/Storage-acmeに似ている場合は、Storage-acmeを選択します。 RESTエンドポイントURLがhttps://storage-7b16fede61e1417ab83eb52e06f0e365.storage.oraclecloud.com/v1/Storage-7b16fede61e1417ab83eb52e06f0e365に類似している場合は、Storage-7b16fede61e1417ab83eb52e06f0e365を選択します。

  2. userパラメータを構成するには、RESTエンドポイントURLの選択された部分の後にコロン(:)を挿入し、ユーザー名を追加します。

    ユーザー名がjack.jones@examples.comで、RESTエンドポイントURLがhttps://acme.storage.oraclecloud.com/v1/Storage-acmeに似ている場合、userパラメータは次のようになります。 
    user=Storage-acme:jack.jones@example.com

    RESTエンドポイントURLがhttps://storage-7b16fede61e1417ab83eb52e06f0e365.storage.oraclecloud.com/v1/Storage-7b16fede61e1417ab83eb52e06f0e365に似ている場合、userパラメータは次のようになります。 

    user=Storage-7b16fede61e1417ab83eb52e06f0e365:jack.jones@example.com

必要なロールの取得

アカウント管理者に連絡して、「Oracle Cloud Infrastructure Classicコンソール」で自分のユーザー名に割り当てられている必要なロールを取得します。

  • Oracle Cloud Infrastructure Object Storage Classicコンテナを作成、更新、および削除するには、Storage_Administratorロールが必要です。

  • Oracle Cloud Infrastructure Object Storage Classicオブジェクトを作成、更新、および削除するには、Storage_ReadWriteGroupロールが必要です。

  • オブジェクトやコンテナの表示または取得には、Storage_ReadGroupロールが必要です。

詳細については、「Oracle Cloud Infrastructure Object Storage Classicの使用」の「Oracle Cloud Infrastructure Object Storage Classicのロールとユーザーについて」を参照してください。

必要なロールが割り当てられていないか、不明な場合は、システム管理者に「Oracle Cloud Infrastructure Classicコンソール」でロールが割り当てられていることを確認するよう依頼してください。 「Oracle Cloudの管理とモニタリング」の「ユーザー・ロールの変更」を参照してください。

FTM CLIの入手

Oracle Cloud Infrastructure Object Storage ClassicのCLIを使用するには、CLIクライアントをダウンロードし、ホストの適切なロケーションに保管します。

  1. FTM CLIクライアントのftmcli.jarファイルは、http://www.oracle.com/technetwork/topics/cloud/downloads/index.htmlからダウンロードします。
  2. このファイルをローカル・ホストの適切な場所(たとえば、/home/jack/FTM_CLI/ftmcli.jar)に保存します。 構成ファイルを作成する場合は、そのファイルを同じ場所に保存する必要がある点に注意してください。 CLIにより、同じ場所にftmcli.logファイルとftmcli.traceファイルが作成されます。 これらのファイルの内容は、問題をデバッグする際に表示できます。
  3. chmodコマンドを使用して、ftmcli.jarファイルにExecute権限を付与します。

構成ファイルの構成

すべてのコマンドで認証情報を入力したり、セッションの開始時に環境変数を構成したり、構成ファイルを新しいパラメータ・セットで更新したりするのを避けるために、複数の構成ファイルにパラメータの組み合わせを永続的に保存できます。 また、構成ファイルの「Oracle Cloud Infrastructure Object Storage Classic File Transfer Managerコマンドライン・インタフェース」(FTM CLI)操作に関連するいくつかのパラメータのデフォルト値を設定することもできます。 コマンド行で--properties-fileコマンド・オプションを使用すると、コマンドを実行する必要のあるサービス・インスタンス、またはコマンドが適切な構成ファイルを指定して使用する必要があるCLIパラメータを指定できます。 FTM CLIクライアントをダウンロードしたローカル・ホストに構成ファイルを作成するには:

  1. 次のサンプル構成ファイルをローカル・ホスト上に適切な名前で格納します: 
    
#---------------Account parameters---------------

# Your user name if you're using FTM CLI 2.4.
user=jack.jones@example.com
# In case of FTM CLI 2.3 or earlier, user=Storage-acme:jack.jones@example.com 
# OR similar to user=Storage-7b16fede61e1417ab83eb52e06f0e365:jack.jones@example.com for REST Endpoint (Permanent)

# REST Endpoint URL for your account
# In case of REST Endpoint (Permanent), use similar to https://storage-7b16fede61e1417ab83eb52e06f0e365.storage.oraclecloud.com/v1/Storage-7b16fede61e1417ab83eb52e06f0e365
rest-endpoint=https://acme.storage.oraclecloud.com/v1/Storage-acme

# Following parameters are deprecated. Supported only for backward compatibility (FTM CLI 2.3 or earlier).
# If rest-endpoint is specified, then the following parameters will be ignored.
# service name (FTM CLI 2.3 or earlier)
#service=Storage

#identity domain name (FTM CLI 2.3 or earlier)
#identity-domain=acme

# Authentication url endpoint of the storage service (FTM CLI 2.3 or earlier)
#auth-url=https://acme.storage.oraclecloud.com

#---------------Other parameters---------------
# segment size in MiBs
segment-size=100

# number of retries
retries=5

# maximum number of threads created to transfer file(s)
max-threads=15

# storage Class (Archive or Standard)
storage-class=Standard

# container for segments, if not specified <container>_segments is used
segments-container=all_segments

# Proxy Host
#https-proxy-host = <proxy_host>

# Proxy Port
#https-proxy-port = <port_numbrt>

    注意:

    REST Endpoint URLパラメータを使用してストレージ・アカウントにアクセスするための認証を取得し、認証URL、サービス名、アイデンティティ・ドメインなどの非推奨のパラメータを取得することはお勧めしません。
  2. 次に示すように、構成ファイル内のパラメータを更新します。
    パラメータ 説明
    user FTM CLI 2.4を使用している場合は、ストレージ・アカウントにアクセスするためのユーザー名です。 アカウント情報の取得を参照してください。

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

    注意:

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

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

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

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

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

    		 クラウド・サービス名。 「RESTエンドポイントURL」を参照してください。
    identity-domain

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

    		 サービス・インスタンスのアイデンティティ・ドメイン。 「アイデンティティ・ドメイン名、ユーザー名、およびパスワード」を参照してください。
    storage-class ストレージ・クラス。

    デフォルトでは、Standardに設定されていますが、Archiveに変更することもできます。 (ArchiveのサポートはOracle Cloud at Customerでは利用できません)。

    max-threads リクエストで使用されるスレッドの最大数。

    1から100までの任意の値を指定できます。 ネットワークの速度と品質に応じて、異なるスレッド数を使用することでFTM CLIのパフォーマンスが向上することがあります。 デフォルトの設定値は、15です。

    retries 障害が発生した際にリクエストを再試行する回数。

    デフォルトの設定値は、5です。
    segment-size セグメントのサイズ(MB単位)

    デフォルトの設定値は、200MBです。
    segments-container アップロード・プロセス時に、セグメントを保存するコンテナ。

    デフォルトの設定値は、all_segmentsです。 セグメントのコンテナが指定されていない場合、セグメントはコンテナ<container>_segmentsに保存されます。この<container>は、マニフェスト・オブジェクトの保存に指定したコンテナの名前です。

    https-proxy-host、https-proxy-port プロキシ・ホストとプロキシ・ポート。

    これらのパラメータを設定するための行は、デフォルトでは実行から除外されます。 コメントを解除して行を含めて、必要に応じてプロキシ・ホストとプロキシ・ポートの値を設定します。

    注意:

    CLIコマンドを実行するときに、--save-auth-keyオプションを指定すると、保存されたパスワードを解読するためのキーがauth-keyパラメータとして構成ファイルに保管されます。 そのパラメータは削除または編集しないでください。

必要な環境変数の設定

すべてのコマンドで認証URL、サービス名、およびアイデンティティ・ドメイン名を入力しないようにするには、セッションの開始時に環境変数に環境変数を保存します。 環境変数の値は、セッションの終了時に失われます。

CLIは、環境変数に構成ファイルよりも高い優先度を設定します。 環境変数がセッションに構成されていない場合、構成ファイルに構成された値は「Oracle Cloud Infrastructure Object Storage Classic File Transfer Managerコマンドライン・インタフェース」(FTM CLI)クライアントによって取得されます。

FTM CLIクライアントをダウンロードしたホストで必要な環境変数を設定するには:

  1. FTM_REST_ENDPOINT環境変数にストレージ・アカウントのRESTエンドポイントを保存します。 「RESTエンドポイントURL」を参照してください。
    RESTエンドポイントがhttps://acme.storage.oraclecloud.com/v1/Storage-acmeに似ている場合は、
    export FTM_REST_ENDPOINT=https://acme.storage.oraclecloud.com/v1/Storage-acme

    RESTエンドポイントがhttps://storage-7b16fede61e1417ab83eb52e06f0e365.storage.oraclecloud.com/v1/Storage-7b16fede61e1417ab83eb52e06f0e365に似ている場合は、 

    export FTM_REST_ENDPOINT=https://storage-7b16fede61e1417ab83eb52e06f0e365.storage.oraclecloud.com/v1/Storage-7b16fede61e1417ab83eb52e06f0e365
  2. ユーザー変数を環境変数FTM_USERに格納します。
    • FTM CLI 2.3以前を使用している場合は、ユーザー・パラメータを作成するには、「ユーザー・パラメータの作成」の指示に従ってください。
      export FTM_USER=myservice-bar:jack.jones@example.com

    • FTM CLI 2.4を使用している場合、ストレージ・アカウントのユーザー名はユーザー・パラメータの値になります。

      export FTM_USER=jack.jones@example.com

    注意:

    「Oracle Cloud Infrastructure Classicコンソール」に適切なロールがあること。 「必要なロールの取得」を参照してください。
  3. (FTM CLI 2.4では非推奨)環境変数FTM_AUTH_URLに認証URLを格納します。
    RESTエンドポイントから認証URLを取得するには、「RESTエンドポイントURL」の指示に従います。
    RESTエンドポイントがhttps://acme.storage.oraclecloud.com/v1/Storage-acmeに似ている場合は、
    export FTM_AUTH_URL=https://acme.storage.oraclecloud.com

    RESTエンドポイントがhttps://storage-7b16fede61e1417ab83eb52e06f0e365.storage.oraclecloud.com/v1/Storage-7b16fede61e1417ab83eb52e06f0e365に似ている場合は、 

    export FTM_AUTH_URL=https://storage-7b16fede61e1417ab83eb52e06f0e365.storage.oraclecloud.com
  4. (FTM CLI 2.4では非推奨)クラウド・サービス名を環境変数FTM_SERVICEに格納します。
    Oracle Cloud Infrastructure Object Storage Classicインスタンスのサービス名を調べるには、「RESTエンドポイントURL」を参照してください。 
    export FTM_SERVICE=myservice
  5. (FTM CLI 2.4で非推奨されました)あなたのアイデンティティ・ドメインの名前を環境変数FTM_IDOMAINに格納してください。
    サービス・インスタンスのアイデンティティ・ドメインを調べるには、「アイデンティティ・ドメイン名、ユーザー名、およびパスワード」の指示に従います。 
    export FTM_IDOMAIN=myIdentity3

注意:

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