Nutanixで利用可能なCLI（Command Line Interface）を覚えてみよう！

みなさん、こんにちは

本日投稿の内容について、以前別サイトで私が投稿したブログの内容です。

サイトの閉鎖に伴い、こちらで再度掲載いたします。

今回はNutanixで利用可能なCLI(Command Line Interface)をご紹介します。

普段Nutanixを運⽤する場合、Prismを利⽤してGUI上で操作することが多いと思います。
実際にたくさんの処理を実行するためにコマンドを利用したい人や⾃動化したい⼈などはどうしてもCLIが必要になります。Nutanixには複数CLIインタフェースが提供されており、運用者の使い勝手で選択することができます。

CLIの関する使い方も含めてご説明します。

1. Nutanixで利用可能なCLIについて

NutanixのCLIは以下の３つが用意されています。

• nCLI (Nutanix CLI)︓Nutanixのクラスタ（AOS）に対してコマンドで操作できます。主にクラスタやコンテナの情報の参照・設定などを⾏うときに利⽤します。
  （利⽤する場合はJREのインストールが必須になります）
• aCLI (Acropolis CLI)︓AHVのハイパーバイザーに対してコマンドで操作できます。仮想マシンや仮想ネットワークおよびイメージやサービスに関する内容を設定・変更するときに利⽤します。
• PowerShell Cmdlets︓Nutanixのクラスタに対してコマンドで操作できます。nCLIと同様の操作が可能です。（利⽤する場合は、Windows環境が必須になります）

また、CLIを利⽤する場合はCVMなどに直接ログインすることで利⽤することは可能ですが、root権限でオペレーションしてシステムをおかしくすることも考えられます。そのため、どうしても利⽤する場合は、リモートの端末に必要なツールをインストールして利⽤することをお薦めします。

aCLIについては、AHVにログインせずCVM経由でSSHでログインするで利⽤可能です。【192.168.5.1のアドレスでrootでログインすることで利⽤します】

コマンドラインでシステム停⽌もできますが、コマンドの打ち間違いで正常終了しないようなオペレーションしないためにも、通常はPrismでのオペレーションをお願いします。

２. Nutanix Command Line Interface(nCLI)について

Nutanixコマンドラインインターフェース（nCLI）を使⽤すると、次のいずれかのマシンからNutanixクラスターに対してシステム管理コマンドを実⾏できます。

• ローカルマシン（推奨）
• クラスタ内の任意のコントローラVM
  

ローカルマシンへのインストールを推奨しているのは、CVMに対してログインせずにIPアドレスなどの引数で操作ができます。これにより、クラスター全体にローカルマシンから操作できるようになります。

3. nCLIのインストール

1. ローカルマシンから利⽤するJavaRuntime Environment（JRE）のバージョンが5.0以上であることを確認最新版はこちら（http://www.java.com/en/download/installed.jsp）からダウンロード可能です
   
   
2. nCLIをダウンロードします
   ・Nutanix Webコンソールに接続します
   ・コンソール上部のユーザーアイコンをクリックし、[Download nCLI]を選択
   ・ローカルマシンにインストールします
   
   
3. Windowsの％PATH％またはLinuxの$ PATH環境変数を設定します
   ・ncliディレクトリ(例︓c:\ncli)
   ・JRE binディレクトリ（例︓c:\ProgramFiles\Java\jrexxxx\bin）

4. ローカルマシンからnCLIセッションを開始

ローカルマシンへのnCLIのインストール⼿順に従って、ローカルシステムにnCLIをインストールします

1. ローカルマシンでコマンドプロンプトを開きます（Linuxの場合はbash、Windowsの場合はCMDなど）
   
   
2. コマンドプロンプトで、次のいずれかのコマンドを使用してnCLIを起動
   
   lncli -s management_ip_addr -u' username ' -p ' user_password ‘
   この場合、コンソールにパスワードが表⽰されます
   
   lncli -s management_ip_addr -u ' ユーザー名 ' –p
   この場合、パスワードを指定するように求められます
   
   
3. management_ip_addrをクラスタ内のNutanixコントローラVMのIPアドレスに置き換えます
   
   
4. usernameをユーザーの名前に置き換えます（指定されていない場合、デフォルトはadminです）
   
   
5. （オプション）user_passwordをユーザーのパスワードに置き換えます

5. コマンドフォーマット

Nutanixのコマンドラインインターフェースコマンドは、次の形式と一致する必要があります

ncli> entity action parameter1=value parameter2=value ... 

エンティティはクラスタやディスクなどのNutanixエンティティに置き換えることができます。アクションは前のエンティティに対する有効なアクションに置き換えることができます。各エンティティには固有の一連のアクションがありますが、すべてのエンティティに共通のアクションはlistです。

たとえば、次のコマンドを入力してクラスタ内のすべてのストレージプールのリストを要求できます

ncli> storagepool list 

一部のアクションではコマンドの最後にパラメータが必要です。たとえば、NFSデータストアを作成するときは、ハイパーバイザーに表示されるデータストアの名前とソースストレージコンテナの名前の両方を指定する必要があります。

ncli> datastore create name = "NTNX-NFS" ctr-name = "nfs-ctr" 

パラメータと値のペアは、有効なエンティティとアクションが先行している限り、任意の順序で並べることができます。

6. 埋め込みのヘルプ

nCLIは、すべてのエンティティおよびアクションに対する支援を提供します。helpコマンドラインで入力することで、3つの詳細レベルのいずれかで追加情報を要求できます。 

help

エンティティとそれに対応するアクションのリストを提供します

entity help

エンティティに関連付けられているすべてのアクションとパラメータ、および必須のパラメータと任意のパラメータの一覧を提供します

entity action help

アクションに関連付けられているすべてのパラメータのリスト、および各パラメータの説明を提供します

nCLIは各レベルで追加の詳細を提供します。nCLIヘルプ出力の範囲を制御するには詳細パラメータを追加します。詳細パラメータは、trueまたはfalseに設定できます。

たとえば、clusterエンティティのすべてのアクションとパラメータの詳細な一覧を要求するには、次のコマンドを入力

ncli> cluster help detailed = true 

説明なしでcluster edit-paramsアクションのパラメーターのリストを表示する場合、次のコマンドを入力することも可能

ncli> cluster edit-params help detailed = false 

nCLIのエンティティの詳細はNutanix Support Portalのコマンドリファレンスをご参照下さい

７. Acropolis Command-Line Interface(aCLI)

Acropolisは、ホスト、ネットワーク、スナップショット、VMを管理するためのコマンドラインインターフェースを提供します

Acropolis CLIへのアクセス

Acropolis CLIにアクセスするには、SSHでクラスター内のController VMにログオンacliし、シェルプロンプトで⼊⼒

Acropolis CLIを終了してシェルに戻るには、<acropolis>プロンプトでexitと⼊⼒します

8. PowerShell Cmdlets

Nutanixはクラスターと対話するためのPowerShellのCmdletsを提供しています

CmdletsはNutanix クラスターからダウンロードされ、Windowsマシンにインストールされます。Cmdletsがインストールされたら、Nutanix CmdletsをクリックするとデスクトップのショートカットがロードされNutanix CmdletsがPowerShellウィンドウで起動します

PowerShell Cmdletsのインストール

利⽤する前に

PowerShellバージョン2以降および.NET Framework 4.0をワークステーションにインストールします

1. Nutanix Webコンソールにサインイン
2. Webコンソールの右上隅にあるユーザーアイコンをクリックして、[Download Cmdlets Installer]を選択
3. インストーラのダウンロードが完了したら、インストーラをダブルクリックして プロンプトに従います。コマンドレットがインストールされ、デスクトップショート カットNutanix Cmdletsが作成されます。ショートカットをダブルクリックして、Nutanix CmdletsがロードされたPowerShellウィンドウを起動します

９. PowerShell Cmdletsの使用方法

クラスタ接続について

コマンドを実⾏する前に、セッションを1つ以上のNutanixクラスタに接続する必要があります

> Connect-NutanixCluster -Server cluster_ip_address -UserName admin_username ` -Password admin_password'

• cluster_ip_addressをクラスターの仮想IPアドレスまたはコントローラーVMのIPアドレスに置き換えます
• 置き換えadmin_usernameNutanixのユーザー名（通常でadmin）
• admin_passwordをNutanixのユーザーパスワードに置き換えます

複数のConnect-NutanixClusterステートメントを使⽤して複数のクラスタに接続します。セッションが複数の クラスタに接続されている場合は、他のコマンドレットのServerパラメーターを使⽤してコマンドを実⾏するための クラスタを指定します

接続されているクラスターから切断するには、切断元のサーバーのIPアドレスを指定してDisconnect-NutanixClusterを実⾏します

接続クラスタ情報

セッションで接続しているクラスターの詳細を取得するには、Get-NutanixClusterコマンドレットを実⾏します 複数のクラスターに接続されている場合は、接続されているクラスターごとに同じ出⼒を取得するように実⾏できます

Get-NutanixCluster -Server cvm_ip_addr

Cmdletsのバージョン情報

実⾏しているコマンドレットのバージョン詳細を取得するには、Get-NutanixCmdletsInfoのCmdletsを実⾏します

Nutanixの環境を⾃動化したい⼈は利⽤⽅法に気をつけながら是⾮使ってみてください。

以上、よろしくお願い致します。