インスタンスを管理するには¶
既存のインスタンスを一覧表示する際、インスタンスタイプ、状態、場所(場所を持つ場合)を表示できます。 またインスタンスをフィルターして興味があるインスタンスだけを表示できます。
全てのインスタンスを一覧表示するには以下のコマンドを入力します:
incus list
表示するインスタンスをフィルターできます。例えば、インスタンスタイプ、状態、またはインスタンスが配置されているクラスタメンバーでフィルターできます:
incus list type=container
incus list status=running
incus list location=server1
インスタンス名でフィルターもできます。 複数のインスタンスを一覧表示するには、名前の正規表現を使います。 例えば以下のようにします:
incus list ubuntu.*
全てのフィルターオプションを見るには incus list --help
と入力します。
すべてのインスタンスを一覧表示するには /1.0/instances
エンドポイントに問い合わせます。
インスタンスのより詳細な情報を表示するには 再帰 を使えます:
incus query /1.0/instances?recursion=2
表示するインスタンスを名前、インスタンスタイプ、状態またはインスタンスが配置されているクラスタメンバで フィルタ できます:
incus query /1.0/instances?filter=name+eq+ubuntu
incus query /1.0/instances?filter=type+eq+container
incus query /1.0/instances?filter=status+eq+running
incus query /1.0/instances?filter=location+eq+server1
複数のインスタンスを一覧表示するには、名前の正規表現を使います。 たとえば:
incus query /1.0/instances?filter=name+eq+ubuntu.*
詳細は GET /1.0/instances
を参照してください。
インスタンスの詳細情報を表示する¶
インスタンスの詳細情報を表示するには以下のコマンドを入力します:
incus info <instance_name>
インスタンスの最新のログを表示するにはコマンドに --show-log
を追加します:
incus info <instance_name> --show-log
インスタンスの詳細情報を表示するには以下のエンドポイントに問い合わせます:
incus query /1.0/instances/<instance_name>
詳細は GET /1.0/instances/{name}
を参照してください。
インスタンスを起動する¶
インスタンスを起動するには以下のコマンドを入力します:
incus start <instance_name>
インスタンスが存在しないか既に稼働中の場合はエラーになります。
起動する際にコンソールにすぐにアタッチするには --console
フラグを渡します。
例えば以下のようにします:
incus start <instance_name> --console
詳細は コンソールにアクセスするには を参照してください。
インスタンスを起動するには、PUT リクエストを送ってインスタンス状態を変更してください:
incus query --request PUT /1.0/instances/<instance_name>/state --data '{"action":"start"}'
API 呼び出しの戻り値には操作 ID が含まれます。これを使って操作の状態を問い合わせできます:
incus query /1.0/operations/<operation_ID>
インスタンスの状態をモニターするには以下のクエリを使います:
incus query /1.0/instances/<instance_name>/state
詳細は GET /1.0/instances/{name}/state
と PUT /1.0/instances/{name}/state
を参照してください。
インスタンスを停止する¶
インスタンスを停止するには以下のコマンドを入力します:
incus stop <instance_name>
インスタンスが存在しないか稼働中ではない場合はエラーになります。
インスタンスを停止するには、PUT リクエストを送ってインスタンス状態を変更します:
incus query --request PUT /1.0/instances/<instance_name>/state --data '{"action":"stop"}'
API 呼び出しの戻り値には操作 ID が含まれます。これを使って操作の状態を問い合わせできます:
incus query /1.0/operations/<operation_ID>
インスタンスの状態をモニターするには以下のクエリを使います:
incus query /1.0/instances/<instance_name>/state
詳細は GET /1.0/instances/{name}/state
と PUT /1.0/instances/{name}/state
を参照してください。
インスタンスを削除する¶
インスタンスがもう不要な場合、削除できます。 削除する前にインスタンスを停止する必要があります。
インスタンスを削除するには以下のコマンドを入力します:
incus delete <instance_name>
インスタンスを削除するには、インスタンスに DELETE リクエストを送ります:
incus query --request DELETE /1.0/instances/<instance_name>
詳細は DELETE /1.0/instances/{name}
を参照してください。
注意
このコマンドはインスタンスとそのスナップショットを永久的に削除します。
間違ってインスタンスを削除するのを防ぐ¶
間違ってインスタンスを削除するのを防ぐにはいくつかの異なる方法があります:
特定のインスタンスが削除されることを防ぐためには、そのインスタンスの
security.protection.delete
をtrue
に設定します。 手順は インスタンスを設定するには を参照してください。CLI クライアントでは、
incus delete
コマンドを使うたびに確認のプロンプトを表示するようなエイリアスを作成します:incus alias add delete "delete -i"
インスタンスを再構築する¶
インスタンスの root ディスクを一掃して再初期化したいがインスタンスの設定は維持したい場合、インスタンスを再構築できます。
再構築はスナップショットが 1 つも存在しないインスタンスでのみ可能です。
再構築の前にインスタンスを停止します。
別のイメージでインスタンスを再構築するには以下のコマンドを入力します:
incus rebuild <image_name> <instance_name>
空のルートディスクでインスタンスを再構築するには以下のコマンドを入力します:
incus rebuild <instance_name> --empty
rebuild
コマンドについての詳細は、 incus rebuild --help
を参照してください。
インスタンスを別のイメージで再構築するには、インスタンスの rebuild
エンドポイントに POST リクエストを送ります。
たとえば:
incus query --request POST /1.0/instances/<instance_name>/rebuild --data '{"source": {"alias":"<image_alias>","server":"<server_URL>", protocol:"simplestreams"}}'
空のルートディスクでインスタンスを再構築するには、 source の type を none
にします:
incus query --request POST /1.0/instances/<instance_name>/rebuild --data '{"source": {"type":"none"}}'
詳細は POST /1.0/instances/{name}/rebuild
を参照してください。