開始

このトピックでは、OCI Modules for PowerShellのインストールおよび構成の方法について説明します。

このトピックでは、OCI Modules for PowerShellのインストールおよび構成の方法について説明します。

前提条件

ここにリストされているすべての要件を満たしていることを確認してください。

モジュールのインストール

  1. PowerShellセッションを開始します:
    1. Windowsでは、「スタート」メニューからPowerShellを起動します。
    2. LinuxまたはMacOSでは、シェル・プロンプトからpwshを実行します:

      $ pwsh
      
      PowerShell 7.1.0
      Copyright (c) Microsoft Corporation. All rights reserved.
      
      https://aka.ms/powershell
      Type 'help' to get help.
      
      PS /Users/username>
      
  2. すべてのOCIモジュールをインストールするには、基本モジュールをインストールします:

    Install-Module OCI.PSModules

    ノート

    OCI.PSModulesモジュールをアンインストールしても、他のOCIモジュールはアンインストールされません。このモジュールによってインストールされた特定のOCIモジュールをアンインストールするには、先にOCI.PSModulesモジュールをアンインストールする必要があります。
  3. 個々のサービスのモジュールのみをインストールできます。OCI Modules for PowerShellでサポートされる各OCIサービスに対応するコマンドレットは、OCI.PSModules.<ServiceName>という名前のPowershellモジュールそれぞれにパッケージ化されています。
  4. PowerShellギャラリからのインストールまたはGitHubからのインストールに進みます。

GitHubからのインストール

GitHubからOCI PowerShellモジュールをインストールするには:

  1. 最新のOCI Modulesアーティファクトをダウンロードし、ローカル・ディレクトリに抽出します。
    ノート

    OCI Modules for PowerShellでサポートされる各OCIサービスに対応するコマンドレットは、OCI.PSModules.<ServiceName>という名前のPowershellモジュールそれぞれにパッケージ化されています。
  2. 抽出したディレクトリをローカルPowerShellリポジトリとして登録します:
    PS /> Register-PSRepository -Name "LocalRepo" -SourceLocation <extractedlocation>
  3. ローカル・リポジトリで使用可能なモジュールを探します:
    PS /> Find-Module -Repository "LocalRepo"
  4. 特定のモジュールをインストールします:
    PS /> Install-Module -Name OCI.PSModules.Objectstorage -Verbose -Repository LocalRepo
    ノート

    各サービス・モジュールは、すべてのサービス・モジュールに共通の機能を提供するOCI.PSModules.Common (共通モジュール)に依存します。サービス・モジュールをインストールすると、そのサービス・モジュールに対応するバージョンのOCI.PSModules.Commonもインストールされます。
  5. インストールされたモジュールは、$Env:PSModulePath環境変数で指定されたパスにあります。またはListAvailableパラメータを指定してGet-Moduleコマンドを実行することで見つけることができます。
    PS /> Get-Module -ListAvailable

yumを使用したインストール

Oracle Linuxバージョン7.xを使用している場合は、yumを使用してOCI PowerShellモジュール・パッケージをインストールできます。

  1. yumを使用してOCI PowerShellモジュールをインストールするには:
    $ sudo yum install oci-powershell-modules
  2. 次のコマンドを使用して、PowerShellセッションを開始し、ダウンロードしたディレクトリ/usr/lib/dotnet/NuPkgsをローカルPowerShellリポジトリとして登録します:
    $ pwsh
    PS /> Register-PSRepository -Name "LocalRepo" -SourceLocation /usr/lib/dotnet/NuPkgs
  3. 次のコマンドを使用して、ローカル・リポジトリで使用可能なモジュールを検索します:
    PS /> Find-Module -Repository "LocalRepo"
  4. 特定のモジュールをインストールします:
    PS /> Install-Module -Name OCI.PSModules.Objectstorage -Verbose -Repository LocalRepo
    ノート

    各サービス・モジュールは、すべてのサービス・モジュールに共通の機能を提供するOCI.PSModules.Common (共通モジュール)に依存します。サービス・モジュールをインストールすると、そのサービス・モジュールに対応するバージョンのOCI.PSModules.Commonもインストールされます。
  5. インストールされたモジュールは、$Env:PSModulePath環境変数で指定されたパスにあります。またはListAvailableパラメータを指定してGet-Moduleコマンドを実行することで見つけることができます。
    PS /> Get-Module -ListAvailable

設定

必要なモジュールをインストールしていない場合は、これらのインストール・ステップに従います。

OCI Modulesのコマンドレットを呼び出す前に、構成フィルを設定し、その後オプションでPowerShellセッションに必要なモジュールをインポートする必要があります。

構成ファイル

構成ファイルでは、ユーザー資格証明やテナンシOCIDなどの重要な構成情報が提供されます。この構成情報は、OCI Modules for PowerShellによってOracle Cloudサービスとの認証および相互作用に使用されます。このファイルは、設定コマンドレットを使用して作成することも、テキスト・エディタを使用して手動で作成することもできます。

セットOCIClientConfig

共通モジュールに含まれるSet-OCIClientConfigコマンドレットを使用すると、順を追って構成ファイルを設定できます。このコマンドレットにより、APIリクエストの署名に使用されるキー・ペアなど、構成ファイルに必要な情報の入力が求められます。

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

手動設定

API署名キー・ペアを手動で設定し、独自の構成ファイルを記述する場合は、SDKおよびツールの構成および必要なキーを参照してください。

ノート

New-OCIClientKeysコマンドレットを使用して、構成ファイルに含めるAPI署名キー・ペアを生成します。

モジュールのインポート

インストールされたモジュールからコマンドを初めて実行するときに、PowerShellが、モジュール(およびその依存関係)を自動的にセッションにインポートします。明示的にモジュールをインポートするには、Import-Moduleコマンドを実行します。

たとえば、アイデンティティ・サービス・モジュールのバージョン1.0.0をインポートするには:

PS /> Import-Module OCI.PSModules.Identity  -RequiredVersion 1.0.0   -Verbose

現在のPowerShellセッションにインポートされたすべてのモジュールを探すには、Get-Moduleコマンドを実行します:

PS /> Get-Module
 
ModuleType Name                            ExportedCommands
---------- ----                            ----------------
    Binary OCI.PSModules.Common            {Clear-OCICmdletHistory, Get-OCIClientSession], Get-OCICmdletHisto…
    Binary OCI.PSModules.Identity          {Add-OCIIdentityUserToGroup, Enable-OCIIdentityMfaTotpDevice…
ノート

各サービス・モジュールは、すべてのサービス・モジュールに共通の機能を提供するOCI.PSModules.Common (共通モジュール)に依存します。サービス・モジュールをインストールすると、そのサービス・モジュールに対応するバージョンのOCI.PSModules.Commonもインストールされます。

モジュールの更新

OCI PowerShellモジュールの新しいバージョンは毎週リリースされます。インストールされているOCI PowerShellモジュールを最新バージョンに更新するには、Update-Moduleコマンドを実行します。

ノート

OCIモジュールを更新する前には、まずそのモジュールをアンインストールする必要があります。モジュールをPowerShellセッションにインポートする際に依存関係の競合を回避するには、インストールされているすべてのOCIモジュールを同じバージョンに更新します。

PS /> Update-Module -Name "OCI.PSModules.*" -Verbose

モジュールのアンインストール

インストールされているモジュールを削除するには、Uninstall-Moduleコマンドレットを使用するか、$Env:PSModulePath環境変数のパスにあるモジュール・フォルダを削除します。

例:

PS /> Uninstall-Module -Name OCI.PSModules.Identity