Oracle Cloud Infrastructureドキュメント

クイックスタート

この項では、OCIコマンドライン・インタフェース(CLI)をすばやくインストールして構成する方法について説明します。

CLIのインストール

この項の内容

この項では、次の環境ですばやくインストールする手順を示します:

Oracle Linux 9

Oracle Linux 9を使用している場合は、dnfを使用してCLIをインストールできます。

ノート

使用可能な更新済のRPMをインストールし、システムが最新であることを確認するために、sudo dnf updateを定期的に実行することを強くお薦めします。

dnfを使用してCLIをインストールする手順:

sudo dnf -y install oraclelinux-developer-release-el9
sudo dnf install python39-oci-cli

CLIはPythonサイト・パッケージにインストールされます:

  • /usr/lib/python3.9/site-packages/oci_cli
  • /usr/lib/python3.9/site-packages/services

ドキュメントおよび例は、 /usr/share/doc/python39-oci-cli-<version>/ディレクトリにインストールされます。

CLIをアンインストールするには:

sudo dnf remove python39-oci-cli

Oracle Linux 8

Oracle Linux 8を使用している場合は、dnfを使用してCLIをインストールできます。

ノート

使用可能な更新済のRPMをインストールし、システムが最新であることを確認するために、sudo dnf updateを定期的に実行することを強くお薦めします。

dnfを使用してCLIをインストールする手順:

sudo dnf -y install oraclelinux-developer-release-el8
sudo dnf install python36-oci-cli

CLIはPythonサイト・パッケージにインストールされます:

  • /usr/lib/python3.6/site-packages/oci_cli
  • /usr/lib/python3.6/site-packages/services

ドキュメントおよびサンプルは、/usr/share/doc/python36-oci-cli-<version>/ディレクトリにインストールされます。

CLIをアンインストールするには:

sudo dnf remove python36-oci-cli

Oracle Linux 7

Oracle Linux 7を使用している場合は、yumを使用してCLIをインストールできます。

yumを使用してCLIをインストールするには:

sudo yum install python36-oci-cli

CLIはPythonサイト・パッケージにインストールされます:

  • /usr/lib/python3.6/site-packages/oci_cli
  • /usr/lib/python3.6/site-packages/services

ドキュメントおよびサンプルは、/usr/share/doc/python36-oci-cli-<version>/ディレクトリにインストールされます。

CLIをアンインストールするには:

sudo yum remove python36-oci-cli

Mac OS

Mac OSでCLIをインストール、アップグレード、およびアンインストールするには、Homebrewを使用できます。

Homebrewを使用してMac OSにCLIをインストールするには:

brew update && brew install oci-cli

Homebrewを使用してMac OS上のCLIインストールをアップグレードするには: 

brew update && brew upgrade oci-cli

Homebrewを使用してMac OSのCLIをアンインストールするには: 

brew uninstall oci-cli

Windows

CLIは、MSIインストーラを使用するか、PowerShellを使用してWindowsにインストールできます。

MSIインストーラを使用してWindowsにCLIをインストールするには:
ノート

MSI CLIインストーラは、Windowsシステム上の既存のバージョンのCLIを上書きします。複数のバージョンの CLIをインストールする必要がある場合は、後続のインストールで仮想環境を作成し、手動インストール方法を使用します。詳細は、Manual and Offline Installationsを参照してください。
  1. Windows用のOCI CLI MSIインストーラをGitHubからダウンロードします。
  2. ダウンロードしたインストーラ実行可能ファイルを実行します。
  3. CLIをインストールするシステム上のローカルディレクトリを選択し、「Next」をクリックします。
  4. インストーラが終了したら、「終了」をクリックします。

PowerShellを使用してWindowsにCLIをインストールするには:

  1. 「管理者として実行」オプションを使用してPowerShellコンソールを開きます。

  2. インストーラが、スクリプトをインストールして実行することで、オートコンプリートを有効にします。このスクリプトの実行を許可するために、RemoteSigned実行ポリシーを有効にする必要があります。

    PowerShellのリモート実行ポリシーを構成するには、次のコマンドを実行します。

    Set-ExecutionPolicy RemoteSigned
  3. Windows 2012およびWindows 2016の場合は、PowerShellでTLS 1.2が使用されるよう強制します:
    [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
  4. インストーラ・スクリプトをダウンロードします:
    Invoke-WebRequest https://raw.githubusercontent.com/oracle/oci-cli/master/scripts/install/install.ps1 -OutFile install.ps1
  5. プロンプト表示ありまたはプロンプト表示なしでインストーラ・スクリプトを実行します:
    1. プロンプトを表示してインストーラ・スクリプトを実行するには、次のコマンドを実行します:
      iex ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/oracle/oci-cli/master/scripts/install/install.ps1'))

      インストール・スクリプトのプロンプトに応答します。

    2. プロンプトを表示せずにインストーラ・スクリプトを実行し、デフォルト設定を受け入れるには、次のコマンドを実行します:
      ./install.ps1 -AcceptAllDefaults

LinuxおよびUnix

ノート

インストーラ・スクリプトにより、CLIとその依存関係、Pythonおよびvirtualenvが自動的にインストールされます。インストーラを実行する前に、要件を満たしていることを確認してください。
ノート

Oracle Linux 8およびOracle Linux Cloud Developer 7には、CLIが事前にインストールされています。
  1. ターミナルを開きます。
  2. インストーラ・スクリプトを実行するには、次のコマンドを実行します:
    bash -c "$(curl -L https://raw.githubusercontent.com/oracle/oci-cli/master/scripts/install/install.sh)"
    ノート:

    プロンプト表示なしで、すべてのデフォルト値を受け入れるサイレント・インストールを実行するには、--accept-all-defaultsパラメータを使用します。
  3. インストール・スクリプトのプロンプトに応答します。

その他の環境

ここにリストされていない環境にCLIをインストールするには、手動およびオフライン・インストールを参照してください。

OCI CLIインストールの検証

  1. コマンド・プロンプトで次のコマンドを実行します:
    oci --version

インストール・スクリプトのプロンプト

インストール・スクリプトによって次の情報の入力を求められます。

  • 互換性のあるバージョンのPythonがインストールされていない場合:
    • WindowsおよびLinux: バイナリおよび実行可能ファイルをインストールする場所を指定するよう求められます。スクリプトによってPythonがインストールされます。
    • MacOS: Pythonのバージョンに互換性がないことが通知されます。インストールを続行する前にアップグレードする必要があります。スクリプトではPythonはインストールされません。
  • CLIを最新バージョンにアップグレードするよう求められたら、Yで応答して既存のインストールを上書きします。
  • PATHを更新するように求められたら、Yで応答して、実行可能ファイルのフルパスを指定せずにCLIを起動できるようにします。こうすると、oci.exeがPATHに追加されます。

構成ファイルの設定

CLIを使用する前に、Oracle Cloud Infrastructureの操作に必要な資格証明を含む構成ファイルを作成する必要があります。このファイルは、設定ダイアログを使用して作成することも、テキスト・エディタを使用して手動で作成することもできます。

設定ダイアログの使用

初回の設定プロセスの手順をCLIによって示すには、setup configコマンドを使用します:
oci setup config
このコマンドを使用すると、構成ファイルの作成に必要な情報とAPI公開キーおよび秘密キーの入力が求められます。設定ダイアログでは、この情報を使用してAPIキー・ペアが生成され、構成ファイルが作成されます。APIキーが作成されたら、コンソールを使用して公開キーをアップロードします。

必要な情報を確認する方法の詳細は、次を参照してください:

手動設定

APIの公開/秘密キーを自分で設定して、自らの構成ファイルを記述する場合、SDKおよびツールの構成を参照してください。

ヒント

oci setup keysコマンドを使用して、構成ファイルに含めるキー・ペアを生成します。

構成ファイルの検証

構成ファイルが完全であることの確認

適切な構成ファイルには、少なくとも1つのプロファイル名([DEFAULT]など)と、ファイルのエントリの項で指定したエントリ(user、fingerprint、key_file、tenancy、regionおよびオプションのpass_phrase)が必要です。

ノート

構成ファイルの例は、構成例の項を参照してください。

ユーザーおよびフィンガープリント情報の確認

ユーザーおよびフィンガープリント情報を確認するには、OCIコンソールにログインし、右上にある「プロファイル」メニューを開いてからユーザー名を選択します。

ユーザー名を選択すると、「ユーザー情報」パネルにOCIDが表示されます。このOCIDが構成ファイル内のユーザー・エントリになります。

フィンガープリントを見つけるには、左下の「リソース」列の「APIキー」セクションに移動します。

構成ファイルへのコメントの追加

構成ファイルにインライン・コメントを追加しないでください。コメントはすべて新しい行に追加します。例:
[DEFAULT]
user=ocid1.user.oc1..<unique_ID>
fingerprint=<your_fingerprint>
key_file=~/.oci/oci_api_key.pem
tenancy=ocid1.tenancy.oc1..<unique_ID>
# Some comment
region=us-ashburn-1

その他の認証方法

CLIでは、一部のサービスに対してトークンベース、インスタンス・プリンシパルおよびリソース・プリンシパル認証もサポートされます。詳細は、SDKの認証方法を参照してください。