本文へジャンプします。

ニフクラ ユーザーガイド

クラウド トップ>ニフクラ CLI

ニフクラ コマンドラインツール

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

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

ニフクラ データ駆動 コマンドラインツールはニフクラの複数サービスに対応しているコマンドラインツールです。
現在対応しているサービスは以下となります。

  • Computing
  • RDB
  • NAS
  • スクリプト
  • DNS
  • ESS
  • オブジェクトストレージサービス
  • サービスアクティビティ
ニフクラ CLI ニフクラ CLI(GitHub)
ニフクラ CLI(PyPI)
ニフクラ CLI(Read the Docs)
インストール (Linux)

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

$ pip install nifcloud-cli

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

$ nifcloud --version
インストール (Windows)

最新のWindows用MSIインストーラをダウンロードして実行します。

ニフクラ CLI 最新リリース (GitHub)

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

C:\> 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
  • ※本ページ記載の金額は、すべて税抜表示です。
  • ※本ページ記載の他社製品名および会社名などは、各社の商標または登録商標です。
  • ※本ページの内容は、2024年2月16日時点の情報です。

推奨画面サイズ 1024×768 以上