よく使用される gcloud compute コマンド

このドキュメントでは、最もよく使用される gcloud compute コマンドをいくつか紹介します。

始める前に

  • まだ認証を設定していない場合は、ここで認証を設定します。認証とは、Google Cloud サービスと API にアクセスするために ID を確認するプロセスです。ローカル開発環境でコードまたはサンプルを実行するには、次のいずれかのオプションを選択して Compute Engine に対する認証を行います。

    1. Install the Google Cloud CLI, then initialize it by running the following command: 

      gcloud init
    2. Set a default region and zone.

プロジェクト情報の取得

プロジェクト メタデータ、SSH 認証鍵、割り当て指標など、Compute Engine プロジェクトに関する情報を取得するには、次のコマンドを実行します。

 gcloud compute project-info describe

プロジェクト情報を取得する方法については、gcloud compute project-info describe リファレンス ドキュメントをご覧ください。

VM の操作

以下では、仮想マシン（VM）インスタンスを操作する一般的なタスクの例を示します。仮想マシン（VM）インスタンスの詳細については、仮想マシン インスタンスをご覧ください。

VM の作成

VM を作成するには、次のコマンドを実行します。

gcloud compute instances create VM_NAME \
    [--image IMAGE | --image-family IMAGE_FAMILY] \
    --image-project IMAGE_PROJECT

次のように置き換えます。

  • VM_NAME: 新しい VM の名前。
  • IMAGE または IMAGE_FAMILY: 次のいずれかを指定します。
    • IMAGE: 公開イメージの必須バージョン。例: --image debian-10-buster-v20200309
    • IMAGE_FAMILY: イメージ ファミリー。これにより、非推奨ではない最新の OS イメージから VM が作成されます。たとえば、--image-family debian-10 を指定すると、Compute Engine は Debian 10 イメージ ファミリーの OS イメージの最新バージョンから VM を作成します。
  • IMAGE_PROJECT: イメージを含むプロジェクト。

VM を作成する方法については、VM インスタンスの作成と起動と gcloud compute instances create リファレンス ドキュメントをご覧ください。

VM の一覧表示

プロジェクト内の VM の一覧を表示するには、次のコマンドを実行します。

gcloud compute instances list

VM を一覧表示する方法については、gcloud compute instances list リファレンス ドキュメントをご覧ください。

GPU を使用する VM の一覧表示

GPU を使用するプロジェクト内の VM の一覧を表示するには、次のコマンドを実行します。

gcloud compute instances list --filter="guestAccelerators.acceleratorCount>0" --format="table(name,zone,guestAccelerators.acceleratorType,guestAccelerators.acceleratorCount,disks.type)"

ローカル SSD を使用する VM の一覧表示

ローカル SSD を使用するプロジェクト内の VM の一覧を表示するには、次のコマンドを実行します。

gcloud compute instances list  --filter="disks.type='SCRATCH'"  --format="table(name,zone,guestAccelerators.acceleratorType,guestAccelerators.acceleratorCount,disks.type)"

VM 情報の取得

VM に関連するすべてのデータを表示するには、次のコマンドを実行します。

gcloud compute instances describe VM_NAME

VM_NAME は VM の名前で置き換えます。

VM の情報を取得する方法については、gcloud compute instances describe リファレンス ドキュメントをご覧ください。

VM の起動

停止した VM を起動するには、次のコマンドを実行します。

gcloud compute instances start VM_NAME

VM_NAME は VM の名前で置き換えます。

VM の起動の詳細については、インスタンスの起動と停止および gcloud compute instances start リファレンス ドキュメントをご覧ください。

VM の停止

VM を停止するには、次のコマンドを実行します。

gcloud compute instances stop VM_NAME

VM_NAME は VM の名前で置き換えます。

VM の停止の詳細については、インスタンスの起動と停止および gcloud compute instances stop リファレンス ドキュメントをご覧ください。

VM へのラベルの追加

VM にラベルを追加するには、次のコマンドを実行します。

gcloud compute instances add-labels VM_NAME \
    --labels=KEY=VALUE

次のように置き換えます。

  • VM_NAME: VM の名前。
  • KEY=VALUE: ラベルの Key-Value ペア。

VM のラベル付けの詳細については、リソースのラベル付けおよび gcloud compute instances add-labels リファレンス ドキュメントをご覧ください。

VM への接続

SSH を使用したインスタンスへの接続

SSH を使用して VM に接続するには、次のコマンドを実行します。

gcloud compute ssh VM_NAME

VM_NAME は VM の名前で置き換えます。

SSH を使用して VM に接続する方法については、Linux VM への接続と gcloud compute ssh リファレンス ドキュメントをご覧ください。

SCP を使用したインスタンスへのファイル転送

ファイルを VM にコピーするには、次のコマンドを実行します。

gcloud compute scp LOCAL_FILE_PATH VM_NAME:REMOTE_DIRECTORY

VM からファイルをコピーするには、次のコマンドを実行します。

gcloud compute scp VM_NAME:REMOTE_DIRECTORY LOCAL_FILE_PATH

次のように置き換えます。

  • LOCAL_FILE_PATH: ワークステーション上のファイルのパス。
  • VM_NAME: VM の名前。
  • REMOTE_DIRECTORY: VM 上のディレクトリのパス。

SCP を使用して VM との間でファイルを転送する方法については、Google Cloud CLI を使用したファイル転送と gcloud compute scp リファレンス ドキュメントをご覧ください。

ディスクの操作

以下では、ディスクを扱う一般的なタスクの例を示します。ディスクの詳細については、ストレージ オプションをご覧ください。

ディスクの一覧表示

プロジェクト内のディスクの一覧を表示するには、次のコマンドを実行します。

gcloud compute disks list

ディスクの一覧を表示する方法については、gcloud compute disks list リファレンス ドキュメントをご覧ください。

スナップショットの操作

以下では、スナップショットを操作する一般的なタスクの例を示します。スナップショットの詳細については、永続ディスクのスナップショットをご覧ください。

スナップショットの一覧表示

プロジェクト内のスナップショットの一覧を表示するには、次のコマンドを実行します。

gcloud compute snapshots list

スナップショットの情報を取得する方法については、gcloud compute snapshots list リファレンス ドキュメントをご覧ください。

スナップショット情報の取得

スナップショットに関連するすべてのデータを表示するには、次のコマンドを実行します。

gcloud compute snapshots describe SNAPSHOT_NAME

SNAPSHOT_NAME は、スナップショットの名前で置き換えます。

スナップショットの情報を取得する方法については、gcloud compute snapshots describe リファレンス ドキュメントをご覧ください。

スナップショットの削除

スナップショットを削除するには、次のコマンドを実行します。

gcloud compute snapshots delete SNAPSHOT_NAME

SNAPSHOT_NAME は、スナップショットの名前で置き換えます。

スナップショットを削除する方法については、スナップショットの削除と gcloud compute snapshots delete リファレンス ドキュメントをご覧ください。

ファイアウォール ルールの操作

以下では、ファイアウォール ルールを操作する一般的なタスクの例を示します。ファイアウォール ルールの詳細については、VPC ファイアウォール ルールの概要をご覧ください。

ファイアウォール ルール情報の取得

ファイアウォール ルールに関連するすべてのデータを表示するには、次のコマンドを実行します。

gcloud compute firewall-rules describe FIREWALL_RULE_NAME

FIREWALL_RULE_NAME の部分は、ファイアウォール ルールの名前に置き換えます。

ファイアウォール ルールの情報を取得する方法については、gcloud compute firewall-rules describe リファレンス ドキュメントをご覧ください。

ファイアウォール ルールの作成

ファイアウォール ルールを作成するには、次のコマンドを実行します。

gcloud compute firewall-rules create FIREWALL_RULE_NAME \
    [--allow=PROTOCOL:PORT | --action=ACTION --rules=PROTOCOL:PORT]

--allow または --action のいずれかと --rules を指定して、次のように置き換えます。

  • FIREWALL_RULE_NAME: ファイアウォール ルールの名前。
  • ACTION: 一致したときのアクション（allow または deny）。
  • PROTOCOL:PORT: ファイアウォール ルールの影響を受けるトラフィックのプロトコルとポート。

ファイアウォール ルールを作成する方法については、ファイアウォール ルールの作成と gcloud compute firewall-rules create リファレンス ドキュメントをご覧ください。

マネージド インスタンス グループ（MIG）の操作

以下では、MIG を操作する一般的なタスクの例を示します。MIG の詳細については、マネージド インスタンス グループ（MIG）をご覧ください。

マネージド インスタンス グループの作成

MIG を作成するには、次のコマンドを実行します。

gcloud compute instance-groups managed create INSTANCE_GROUP_NAME \
    --size=SIZE \
    --template=INSTANCE_TEMPLATE

次のように置き換えます。

  • INSTANCE_GROUP_NAME: このインスタンス グループの名前。
  • SIZE: インスタンス グループのサイズ。
  • INSTANCE_TEMPLATE: このグループに使用するインスタンス テンプレートの名前。

MIG の作成の詳細については、MIG を作成するための基本的なシナリオと gcloud compute instance-groups managed create リファレンス ドキュメントをご覧ください。

自動スケーリングの設定

MIG に CPU の使用率に基づく自動スケーリングを設定するには、次のコマンドを実行します。

gcloud compute instance-groups managed set-autoscaling INSTANCE_GROUP_NAME \
    --max-num-replicas=MAX_NUM_REPLICAS \
    --target-cpu-utilization=TARGET_CPU_UTILIZATION

次のように置き換えます。

  • INSTANCE_GROUP_NAME: MIG の名前
  • MAX_NUM_REPLICAS: オートスケーラーによって作成されるレプリカの最大数
  • TARGET_CPU_UTILIZATION: オートスケーラーが維持する必要がある CPU レベル（0.0～1.0）

自動スケーリングを設定する方法については、インスタンスのグループの自動スケーリングと gcloud compute instance-groups managed set-autoscaling リファレンス ドキュメントをご覧ください。

メタデータの操作

以下では、メタデータを扱う一般的なタスクの例を示します。メタデータの詳細については、メタデータの保存と取得をご覧ください。

プロジェクト レベルのメタデータの追加

プロジェクトにメタデータを追加するには、次のコマンドを実行します。

gcloud compute project-info add-metadata VM_NAME \
    --metadata=KEY=VALUE,[KEY=VALUE]

次のように置き換えます。

  • VM_NAME: VM の名前
  • KEY=VALUE: メタデータの Key-Value ペア

VM にメタデータを追加する方法については、プロジェクト全体のカスタム メタデータの設定と gcloud compute project-info add-metadata リファレンス ドキュメントをご覧ください。

インスタンス レベルのメタデータの追加

VM にメタデータを追加するには、次のコマンドを実行します。

gcloud compute instances add-metadata VM_NAME \
    --metadata=KEY=VALUE,[KEY=VALUE]

次のように置き換えます。

  • VM_NAME: VM の名前
  • KEY=VALUE: メタデータの Key-Value ペア

VM にメタデータを追加する方法については、インスタンス メタデータの設定と gcloud compute instances add-metadata リファレンス ドキュメントをご覧ください。

ヘルプページの取得

次のコマンドは、gcloud compute コマンドに関する一般的なヘルプから、リソース グループ（instances）やコマンド（create）に関する特定のヘルプに至るまで、さまざまなタイプのヘルプにアクセスする方法を示しています。

gcloud compute --help
 
gcloud compute instances --help
 
gcloud compute instances create --help

クイックヘルプは、--help フラグではなく、-h フラグを使用して取得できます。また、Google Cloud CLI リファレンスで包括的なヘルプを確認することもできます。

gcloud CLI の構成に使用するコマンドについて包括的なヘルプを表示するには、次のコマンドを実行します。

gcloud topic TOPIC

TOPIC は、必要なヘルプのトピックで置き換えます。ヘルプを利用できるトピックのリストについては、gcloud topic リファレンス ドキュメントをご覧ください。

次のステップ