クラウド CLI（コマンドラインツールについて）

コマンドラインツール

当サービスでのリソースの作成・起動・停止やステータス参照などの操作を可能にするコマンドラインツールです。
スクリプトを作成して操作の自動化を容易に実現できます。

データ駆動 コマンドラインツール

データ駆動 コマンドラインツールは当サービスの複数サービスに対応しているコマンドラインツールです。

CLI	CLI v1.17.0(zip) CLI（PyPI） CLI（Read the Docs）

• 現在対応しているサービスは以下のとおりです。
  • Computing
  • RDB
  • DNS
  • ESS
  • オブジェクトストレージサービス
  • NAS
  • DevOps with GitLab
  • サービスアクティビティ

実行前準備

インストール

pipを利用してインストールする場合

• 以下のコマンドを実行してインストールします。

  $ pip install nifcloud-cli

• 以下のコマンドを実行し、バージョン情報が出力されれば、正常にインストールされています。

  $ nifcloud --version

zipファイルをダウンロードし、手動でインストールを行う場合

• 最新版のCLI v1.17.0(zip)をダウンロードします。

• ダウンロードしたzipファイルを任意のディレクトリに展開します。

• 展開されたディレクトリにて以下のコマンドを実行して、nifcloud-cliをインストールします。
  Python3.11以上がインストールされており、環境変数PATHに設定されている必要があります。

  $ pip install uv

  $ uv venv

  • Windowsの場合:

    $ .venv\Scripts\activate

  • Linux/macOSの場合:

    $ source .venv/bin/activate

  $ uv pip install .

• 以下のコマンドを実行し、バージョン情報が出力されれば、正常にインストールされています。

  $ nifcloud --version

認証情報等の設定

環境変数、もしくは nifcloud configure コマンドから設定できます。
頻繁にCLIを利用するなど、設定を永続化するには nifcloud configure コマンドを利用してください。
デフォルトリージョンも設定できます。利用可能なリージョンの一覧はクラウド技術仕様/制限値(共通:基本仕様)を参照してください。

環境変数での設定方法

• Linuxの場合

  $ export NIFCLOUD_ACCESS_KEY_ID=<Your NIFCLOUD Access Key ID>
  $ export NIFCLOUD_SECRET_ACCESS_KEY=<Your NIFCLOUD Secret Access Key>
  $ export NIFCLOUD_DEFAULT_REGION=jp-east-1

• Windowsの場合

  C:\> set NIFCLOUD_ACCESS_KEY_ID=<Your NIFCLOUD Access Key ID>
  C:\> set NIFCLOUD_SECRET_ACCESS_KEY=<Your NIFCLOUD Secret Access Key>
  C:\> set NIFCLOUD_DEFAULT_REGION=jp-east-1

nifcloud configure コマンドでの設定方法

$ nifcloud configure
NIFCLOUD Access Key ID [None]:
NIFCLOUD Secret Access Key [None]:
Default region name [None]:
Default output format [None]:

なお、ここで入力した内容は以下のディレクトリ配下に保存されます。

• Linuxの場合
  • $HOME/.nifcloud
• Windowsの場合
  • %UserProfile%\.nifcloud

動作確認

サーバー情報取得のコマンドを実行して動作を確認します。

$ nifcloud computing describe-instances

コマンドの使い方は、ヘルプオプションでも確認できます。

$ nifcloud computing describe-instances help

CLIの利用履歴

CLIの利用履歴はアクティビティログに記録されます。
アクティビティログの操作方法はクラウド操作方法ガイド(アカウントメニュー:アクティビティログ)を確認してください。

記録されるログは以下の形式となります。

2025/2/21 13:58:36 BCT***** ***.***.***.*** コンピューティング API（利用状況） DescribeUsage[yearMonth:202502,isCharge:false] 正常
2025/2/21 13:58:31 BCT***** ***.***.***.*** コンピューティング API（ダッシュボード） DescribeResources[] 正常

エンドポイントについて

各サービスで利用可能なリージョン/エンドポイントは、API（エンドポイント）を確認してください。

Terraform プロバイダー

当サービスの各種リソースを Terraform / OpenTofu からコードで管理できるようにするプラグインです。

Terraform プロバイダー

terraform-provider-nifcloud v1.18.0 ソースコード(zip) terraform-provider-nifcloud v1.18.0 バイナリ(zip)

インストール

1. 最新版のterraform-provider-nifcloud v1.18.0 バイナリ(zip) をダウンロードします。

2. ダウンロードしたzipファイルを任意のディレクトリに展開します。

3. 展開したディレクトリの中から、ご利用のOSとアーキテクチャに合ったバイナリを探します。展開されたディレクトリ直下に linux_amd64などのようなフォルダがあり、その中にプロバイダーのバイナリが存在します。

4. Terraform / OpenTofu がプロバイダーを認識できるように、以下の方法でバイナリを配置します。

   • ホームディレクトリに .terraform.d/plugins/<HOSTNAME>/<NAMESPACE>/<TYPE>/<VERSION>/<os_arch> というディレクトリ構造を作成し、その中にバイナリファイルを配置します。

     例 ~/.terraform.d/plugins/registry.terraform.io/nifcloud/nifcloud/1.18.0/linux_amd64

5. プロバイダーを設定した後、Terraform / OpenTofu プロジェクトのディレクトリで以下のコマンドを実行します。

   $ terraform init

   または

   $ opentofu init

6. Terraform / OpenTofu がプロバイダーを認識し、初期化が完了します。