ニフクラ コマンドラインツール
ニフクラでのリソースの作成・起動・停止やステータス参照などの操作を可能にするコマンドラインツールです。
スクリプトを使用し操作の自動化が容易に実現できます。
ニフクラ データ駆動 コマンドラインツール
ニフクラ データ駆動 コマンドラインツールはニフクラの複数サービスに対応しているコマンドラインツールです。
現在対応しているサービスはComputing、RDB、NAS、スクリプト、Kubernetes Service Hatoba、DNS、ESS、オブジェクトストレージサービス、サービスアクティビティです。
ニフクラ データ駆動 コマンドラインツールでは下記のコマンドラインツールを提供しております。
| ニフクラ CLI | ニフクラ CLI（GitHub） ニフクラ CLI（PyPI） ニフクラ CLI（Read the Docs） |
インストール (Linux)
以下のコマンドを実行してインストールを実施します。
$ pip install nifcloud-cli下記のコマンドを実行し、バージョン情報が出力されれば、正常にインストールされています。
$ nifcloud --versionインストール (Windows)
最新のWindows用MSIインストーラをダウンロードして実行します。
下記のコマンドをコマンドプロンプトから実行し、バージョン情報が出力されれば、正常にインストールされています。
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-1nifcloud 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ニフクラ
ニフクラでは2021年09月より、従来のCLIよりも多機能・高機能な「ニフクラ データ駆動 コマンドラインツール」のニフクラ CLIを提供しております。
これに伴い、これまで提供しておりました「ニフクラ コマンドラインツール」のニフクラ CLI 8.0.2およびその過去バージョンにつきましては、2022年06月01日にアップデートを停止し、2023年06月30日にダウンロード停止・サポート終了といたします。
2022年06月01日以降は、「ニフクラ データ駆動 コマンドラインツール」のニフクラ CLIのみを順次アップデートさせていただきますので何卒ご了承ください。
つきましては、必要に応じてアップデートが停止するCLIから「ニフクラ データ駆動 コマンドラインツール」のニフクラ CLIへの移行をお願いいたします。
具体的な移行手順はお客様にてご検討いただくようお願いいたします。
なお、「ニフクラ データ駆動 コマンドラインツール」CLIとニフクラ CLI 8.0.2およびその過去バージョンのCLIとのコマンドラインオプションに関する互換性はありません。予めご了承ください。
ニフクラでは下記のコマンドラインツールを提供しております。
| ニフクラ コマンドラインツール | ニフクラ CLI 8.0.2 ニフクラ CLI コマンド一覧 共通オプション |
ご利用方法
実行環境へ最新版をダウンロード
任意のフォルダまたはディレクトリへzipファイルを保存し、解凍します。
コマンドファイル(bin配下のファイル)には適宜実行権を付与してご利用ください。
環境変数の設定
コマンドラインツールの動作には、環境変数を設定する必要があります。
以下のページより、環境変数と設定方法をご確認ください。
実行
サーバー情報取得のコマンドを実行して動作を確認します。
$ nifty-describe-instances
GROUP fwgroup01
INSTANCE server01 i-0000usn7 68 stopped sshkey01 mini 2019-01-01T09:00:00+09:00 east-11 disabled disk 1 1 static static memo x86_64 centos STANDARD default 2
NETWORK_INTERFACE net-COMMON_GLOBAL in-use
NETWORK_INTERFACE_ATTACHMENT 0 attached true
NETWORK_INTERFACE_ASSOCIATION
NETWORK_INTERFACE net-COMMON_PRIVATE in-use
NETWORK_INTERFACE_ATTACHMENT 0 attached trueコマンドの使い方は、ヘルプオプションでも確認できます。
$ nifty-describe-instances --help
