OCIユーティリティ

Oracle Linuxプラットフォーム・イメージを使用するインスタンスには、インスタンスがインフラストラクチャ・リソースに関する情報にアクセスできるようにする一連のユーティリティ(oci-utils)が含まれます。これらのユーティリティは、リソースの自動検出またはプロビジョニングに役立つサービス・コンポーネントおよびコマンドライン・ツールで構成されます。

OCIユーティリティのインストール

Oracle Linuxインスタンスには、Oracle Cloud Infrastructure (OCI)ユーティリティ(oci-utils)パッケージがインストールされています。これらのユーティリティは、他のディストリビューションでは使用できません。

OCIユーティリティを使用するには、次の前提条件を満たす必要があります。

  • oci_includedリポジトリが有効になります。このリポジトリは、Oracle Linuxプラットフォーム・イメージではデフォルトで有効になっています。リポジトリには、必要なOCI SDKおよびPythonパッケージを含む、必要なすべてのパッケージが含まれます。oci-utilsパッケージは、すべての依存関係を提供します。
  • OCIユーティリティには、Oracle Cloud Infrastructureへのアクセスに必要な権限があります。これは、次のいずれかを実行することで実現できます。
    • ホストのSDK構成ファイルを作成します。詳細は、SDKおよびCLIの構成ファイルを参照してください。
      ノート

      SDK構成ファイルを作成するためにoci setup configコマンドを実行する前に、CLIをインストールする必要がある場合があります。詳細は、Installing the CLIを参照してください。
    • Oracle Cloud Infrastructureサービスへのアクセス権を付与された動的グループにインスタンスを追加してインスタンス・プリンシパルを使用します。詳細は、動的グループの管理を参照してください。
    • oci-utilsを構成して、rootアカウントが権限のないユーザーのOCI構成ファイルを使用できるようにします。詳細は、インスタンスの/etc/oci-utils.conf.dディレクトリにある構成ファイルを参照してください。
  • OCIユーティリティに必要な権限を確保した後、ユーティリティへのアクセスおよびそのメソッドに必要な設定の実行に使用する次の方法のいずれかを選択します。

OCIユーティリティをインストールおよび設定する方法を示すビデオについては、Oracle Cloud Infrastructureインスタンス上のOracle LinuxでのOCIユーティリティの有効化を参照してください

OCIユーティリティの更新

oci-utilsの最新バージョンに更新するには、次のコマンドを実行します。

sudo dnf update oci-utils

ocidデーモンの使用

ocidデーモンは、oci-utilsのサービス・コンポーネントです。これは、インスタンスのVNICおよびiSCSI構成内の変化を監視し、デバイスの出現や消失に合わせてデバイスを自動的にアタッチまたはデタッチを試みます。たとえば、Oracle Cloud Infrastructure Console、CLIまたはAPIを使用して作成または削除された場合です。

systemdを使用してocidデーモンをすぐに起動し、システムの起動時に自動的に起動するには、次のコマンドを実行します。

sudo systemctl enable --now ocid.service

サービスがアクティブ(実行中)であることを確認するには、次のコマンドを実行します。

sudo service ocid status

出力は次のようになります:

$ sudo service ocid status
Redirecting to /bin/systemctl status ocid.service
● ocid.service - Oracle Cloud Infrastructure utilities daemon
     Loaded: loaded (/etc/systemd/system/ocid.service; enabled; preset: disabled)
     Active: active (running) since date and time; 9s ago
 Invocation: edd65c2c534949f3a3fb1a77d0aecccf
   Main PID: 361841 (python3)
      Tasks: 4 (limit: 72765)
     Memory: 127.3M (peak: 127.8M)
        CPU: 1.424s
     CGroup: /system.slice/ocid.service
             └─361841 /usr/bin/python3 /usr/lib/python3.12/site-packages/oci_utils/impl/ocid_main.py --no-daemon
date and time hostname systemd[1]: Starting ocid.service - Oracle Cloud Infrastructure utilities daemon...
date and time hostname systemd[1]: Started ocid.service - Oracle Cloud Infrastructure utilities daemon.

        

OCIユーティリティ・サマリー

OCIユーティリティ・コンポーネントのサマリー。

名前 説明
ocid oci-utilsのサービス・コンポーネントで、systemdによって起動されたデーモンとして実行されます。このサービスは、iSCSIおよびVNICデバイス構成の変更をスキャンして、インスタンスのOCIメタデータとパブリックIPアドレスをキャッシュします。
oci-compartmentid インスタンスが実行されているコンパートメントのOracle Cloud Identifier(OCID)が表示されます。
oci-growfs インスタンスのルート・ファイル・システムを構成したサイズに拡張します。
oci-image-expand Oracle Linux Minimalインスタンスを変換して、標準のOracle Linuxプラットフォーム・イメージのサービスおよびパッケージを追加します。
oci-instanceid インスタンスのOCIDを表示します。
oci-iscsi-config コンピュート・インスタンスにアタッチされたiSCSIデバイスを構成します。コマンドライン・オプションを指定しないと、注意が必要なデバイスがリストされます。
oci-metadata コンピュート・インスタンスのメタデータを表示します。コマンドライン・オプションを指定しないと、使用可能なすべてのメタデータがリストされます。メタデータには、インスタンスOCID、表示名、コンパートメント、シェイプ、リージョン、可用性ドメイン、作成日、状態、イメージ、および指定した任意のカスタム・メタデータ(SSH公開キーなど)が含まれます。
oci-network-config コンピュート・インスタンスにアタッチされた仮想ネットワーク・インタフェース・カード(VNIC)をリストまたは構成します。クラウド内でセカンダリVNICがプロビジョニングされるときは、このスクリプトまたは同様のコマンドを使用して、インスタンスでそれを明示的に構成する必要があります。
oci-network-inspector 特定のコンパートメントまたはネットワークの詳細レポートを表示します。
oci-notify 通知サービス・トピックにメッセージを送信します。
oci-public-ip 現在のシステムのパブリックIPアドレスを、判読可能な形式またはJSON形式で表示します。
oci-volume-data インスタンスにアタッチされている特定のiSCSIボリュームに関するデータを表示します。

一般的なOCIユーティリティ・オプション

Oracle Cloud Infrastructure (OCI)ユーティリティの多くには、コマンドラインからユーティリティを実行するときに使用できる同じオプションまたは引数があります。これらのオプションおよび引数によって、ユーティリティによって生成される情報のタイプ、またはタスクの実行方法がさらに定義されます。

次の表に、OCIユーティリティ全体で共通のオプションとその可能な値を示します。

オプション 説明
--help ユーティリティの使用状況、使用可能なオプション、各オプションの可能な値など、ユーティリティーに関するヘルプ情報を表示します。たとえば、oci-metadataユーティリティのヘルプを表示するには:
$ sudo oci-metadata --help

usage: oci-metadata [-h] [-j] [-g KEY] [--value-only] [--export] [--trim]
                    [-u KEY=VALUE  [KEY=VALUE  ...]] [-i OCID] [--help]

Utility for displaying metadata for an instance running in the Oracle Cloud
Infrastructure.

optional arguments:
  -h, --human-readable  Display human readable output (default)
  -j, --json            Display json output
  ...
  --help                Display this help

--all

すべてのアイテムまたは値を出力に表示します。

--details

出力に詳細情報を表示します。

--output-mode

出力の表示方法を定義できます。次のオプションがあります:

  • json: 出力をJSON形式で表示されます。
  • human-readable: 判読可能な形式で出力を表示します。
  • parsable: 出力を解析可能な形式で表示します。
  • table: 表に出力を表示します。
  • text: テキスト出力を表示します。

--no-truncate

表示された出力の値を短くしません。

--truncate

表示された出力の値を短くします。

-y| --yes

すべてのプロンプトで「yes」と回答します。

-n | --no

すべてのプロンプトで「いいえ」と答えます。

-q | --quiet

情報メッセージを抑制します。

ノート

各OCIユーティリティのマニュアル・ページは、コマンドラインでman oci-utilityと入力することで表示できます。たとえば、oci-metadataユーティリティの組込みマニュアル・ページを表示するには:
man oci-metadata