ゲスト エージェントを構成する


このドキュメントでは、構成ファイルを編集してゲスト エージェント サービスを管理し、その機能を構成する方法について説明します。

ゲスト エージェントは、ゲスト環境の重要なコンポーネントです。ゲスト環境には、Compute Engine でインスタンスを実行するために必要なスクリプト、デーモン、バイナリが含まれています。ゲスト環境の詳細については、ゲスト環境をご覧ください。ゲスト エージェントは、Google 提供の OS イメージのデフォルト設定でデフォルトで動作しますが、動作をカスタマイズすることもできます。ゲスト エージェントのコア機能の詳細については、ゲスト エージェントの機能をご覧ください。

ゲスト エージェントを再起動する

ゲスト エージェントは、Linux オペレーティング システムと Windows オペレーティング システムの両方でデーモンとして実行されます。Linux では、ゲスト エージェントは systemd サービスとして起動し、Windows ではシステム サービスとして起動します。

再起動の手順は、Linux と Windows のオペレーティング システムで次のように異なります。

Linux

Linux で再起動するには、次のいずれかのオプションを選択します。

  • ゲスト エージェントのバージョンが 20250901.00 以降の場合は、次のコマンドを実行します。

    ggactl_plugin coreplugin restart
  • 以前のゲスト エージェント バージョンの場合は、次のコマンドを実行します。

    systemctl restart google-guest-agent

Windows

Windows で再起動するには、次のいずれかのオプションを選択します。

  • ゲスト エージェントのバージョンが 20250901.00 以降の場合は、次のコマンドを実行します。

    ggactl_plugin coreplugin restart
  • 以前のゲスト エージェント バージョンの場合は、次の PowerShell コマンドを使用します。

    1. ゲスト エージェントを停止するには:

      Stop-Service GCEAgent

    2. ゲスト エージェントを起動するには:

      Start-Service GCEAgent

    または、ゲスト エージェントを再起動するには:

    Restart-Service GCEAgent

すべてのゲスト エージェント バージョンで、タスク マネージャーを使用して GCEGuestAgent サービスを見つけて再起動することもできます。

ゲスト エージェントの構成ファイルを更新する

構成ファイル instance_configs.cfg を編集して、ゲスト エージェントの動作をカスタマイズできます。このファイルでは、機能を有効または無効にしたり、オペレーションのデフォルト値を設定したりできます。

Linux オペレーティング システムと Windows オペレーティング システムで instance_configs.cfg ファイルを編集するには、次のセクションをご覧ください。

Linux

Linux VM で構成ファイルを編集するには、次の操作を行います。

  1. /etc/default/instance_configs.cfg にある構成ファイルを作成または編集し、必要なオプションを設定します。オプションの一覧については、構成オプションをご覧ください。

    たとえば、新しいユーザーの作成方法をカスタマイズし、生成する SSH ホスト鍵のタイプを指定するには、次の内容でファイルを作成または更新します。

    [Accounts]
    useradd_cmd = useradd -m -G google-sudoers
    [InstanceSetup]
    host_key_types = ecdsa,ed25519
    

    注: Linux ディストリビューションでは、/etc/default/instance_configs.cfg.distro に独自のデフォルト設定が用意されている場合があります。エージェントはこれらの設定を最初に読み取りますが、/etc/default/instance_configs.cfg で定義した設定は、配布のデフォルトをオーバーライドします。これにより、パッケージの更新中にカスタム構成が失われないようにします。

  2. 構成ファイルを変更したら、変更を有効にするためにゲスト エージェントを再起動します。

Windows

Windows VM では、構成ファイルは C:\Program Files\Google\Compute Engine\instance_configs.cfg にあります。Windows でのエージェントの構成の詳細については、Windows インスタンスの機能の有効化と無効化をご覧ください。

構成オプション

次の表に、instance_configs.cfg ファイルで使用可能な構成オプションを示します。

アカウント

instance_configs.cfg ファイルの Accounts セクションのオプションを使用して、ゲスト エージェントによるユーザーとグループの管理を制御します。

オプション 説明 オペレーティング システム デフォルト値
deprovision_remove true に設定されている場合、ユーザー アカウントが削除されると、ユーザーのホーム ディレクトリも削除されます。デフォルトでは、ユーザー アカウントのみが削除され、ディレクトリはそのまま残ります。 Linux false
groups 新しいユーザーのグループのカンマ区切りリスト。 Linux 空白
useradd_cmd 新しいユーザーを作成するときにゲスト エージェントが実行するコマンドを設定します。たとえば、ユーザーのホーム ディレクトリを作成して google-sudoers グループに追加するには、値を useradd -m -G google-sudoers に設定します。 Linux システムのデフォルト
userdel_cmd ユーザーの削除時にゲスト エージェントが実行するコマンドを設定します。たとえば、ユーザーのホーム ディレクトリとファイルを削除するには、値を userdel -r に設定します。 Linux システムのデフォルト
usermod_cmd ユーザーのグループを変更するときにゲスト エージェントが実行するコマンドを設定します。 Linux システムのデフォルト
gpasswd_add_cmd ユーザーをグループに追加するときにゲスト エージェントが実行するコマンドを設定します。 Linux システムのデフォルト
gpasswd_remove_cmd グループからユーザーを削除するときにゲスト エージェントが実行するコマンドを設定します。 Linux システムのデフォルト
groupadd_cmd 新しいグループの作成時にゲスト エージェントが実行するコマンドを設定します。 Linux システムのデフォルト

コア

instance_configs.cfg ファイルの Core セクションのオプションを使用して、ゲスト エージェントのコア機能を制御します。

オプション 説明 オペレーティング システム デフォルト値
cloud_logging_enabled false に設定すると、ゲスト エージェントはアクティビティ ログを Cloud Logging に送信しません。 Linux と Windows true
log_level ゲスト エージェントのログのロギングレベルを設定します。この設定は、Cloud Logging だけでなく、ゲスト エージェントによって生成されたすべてのログに適用されます。設定とレベルは次のとおりです。
  • 0 (FATAL): エージェントの停止を引き起こす重大なエラーをログに記録します。
  • 1 (ERROR): エージェントの実行を妨げる可能性のあるエラーをログに記録します。
  • 2 (WARN): 有害な可能性のある条件をログに記録します。
  • 3 (INFO): エージェント アクティビティに関する情報メッセージをログに記録します。これがデフォルトの設定です。
  • 4 (DEBUG): デバッグ情報をログに記録します。この情報は詳細なものになる可能性がありますが、log_verbosity オプションを使用すると、詳細レベルを下げることができます。
Linux と Windows 3
log_verbosity DEBUG ログのロギング詳細レベルを設定します。有効な値は 04 です。値が大きいほど、レスポンスは詳細になります。 Linux と Windows 0

デーモン

instance_configs.cfg ファイルの Daemons セクションのオプションを使用して、ゲスト エージェントによって管理される特定のバックグラウンド デーモンを有効または無効にします。

オプション 説明 オペレーティング システム デフォルト値
accounts_daemon false に設定すると、ゲスト エージェントはユーザー アカウントと SSH 認証鍵の管理を無効にします。 Linux true
clock_skew_daemon false に設定すると、ゲスト エージェントはクロック同期を無効にします。 Linux true
network_daemon false に設定すると、ゲスト エージェントはネットワーク管理を無効にします。 Linux true

インスタンスの設定

instance_configs.cfg ファイルの InstanceSetup セクションのオプションを使用して、インスタンスの初回設定時にゲスト エージェントによって実行されるさまざまなタスクを制御します。

オプション 説明 オペレーティング システム デフォルト値
host_key_types 生成するホストキータイプのカンマ区切りのリスト。 Linux ecdsa,ed25519,rsa
optimize_local_ssd false に設定すると、ゲストは起動時にローカル SSD を最適化しません。 Linux true
network_enabled false に設定すると、ゲスト エージェントはメタデータ情報を必要とするインスタンス設定関数をスキップします。このオプションを false に設定すると、ホストキーの生成も無効になり、ゲスト エージェントが boto 構成ファイルを構成できなくなります。 Linux と Windows true
set_boto_config false に設定すると、ゲスト エージェントは boto 構成ファイルを作成または更新しません。Boto ライブラリを使用し、Cloud Storage へのアクセスにデフォルトのゲスト エージェント構成を使用するアプリケーションは、手動で boto を構成しないと、期待どおりに機能しない可能性があります。 Linux と Windows true
set_host_keys false に設定すると、ゲスト エージェントは初回起動時のホストキーの生成をスキップします。 Linux true
set_multiqueue false に設定すると、ゲスト エージェントはネットワーク ドライバのマルチキュー機能を有効にしてネットワーク パフォーマンスを最適化しようとしません。true の場合、エージェントはネットワーク トラフィックに複数のキューを使用するようにシステムを構成します。これにより、スループットが向上し、レイテンシが短縮される可能性があります。 Linux true

IP 転送

instance_configs.cfg ファイルの IpForwarding セクションのオプションを使用して、ゲスト エージェントが IP 転送とルーティングを管理する方法を構成します。

オプション 説明 オペレーティング システム デフォルト値
ethernet_proto_id デーモン追加ルートのプロトコル ID 文字列。 Linux 66
ip_aliases false に設定すると、ゲスト エージェントはエイリアス IP ルートを設定しません。 Linux true
target_instance_ips false に設定すると、ゲスト エージェントは内部 IP アドレスのロード バランシングを有効にしません。 Linux true

メタデータ スクリプトの実行

instance_configs.cfg ファイルの MetadataScripts セクションのオプションを使用して、起動スクリプトやシャットダウン スクリプトなどのメタデータ スクリプトの実行を制御します。

オプション 説明 オペレーティング システム デフォルト値
default_shell スクリプトを実行するデフォルトのシェル。 Linux /bin/bash
run_dir メタデータ スクリプト実行のベース ディレクトリ。 Linux /var/run/google-startup-scripts
startup false に設定すると、ゲスト エージェントはメタデータから起動スクリプトを実行しません。 Linux と Windows true
shutdown false に設定すると、ゲスト エージェントはメタデータからシャットダウン スクリプトを実行しません。 Linux と Windows true

ネットワーク インターフェース

instance_configs.cfg ファイルの NetworkInterfaces セクションのオプションを使用して、ゲスト エージェントが VM のネットワーク インターフェースを管理する方法を制御します。

オプション 説明 オペレーティング システム デフォルト値
setup false に設定すると、ゲスト エージェントはネットワーク インターフェースの設定をスキップします。 Linux true
ip_forwarding false に設定すると、ゲスト エージェントは IP 転送をスキップします。 Linux true
manage_primary_nic true に設定すると、ゲスト エージェントがプライマリ NIC とセカンダリ NIC を管理します。 Linux false
dhcp_command ネットワーク インターフェースを有効にするための代替 DHCP 実行可能ファイルのパス。 Linux 空白
restore_debian12_netplan_config true に設定すると、ゲスト エージェントは /etc/netplan/90-default.yaml にある Debian 12 のデフォルトの netplan 構成を再作成します。 Linux(Debian 12) true

OS ログイン

instance_configs.cfg ファイルの OSLogin セクションのオプションを使用して、ゲスト エージェントと OS Login の統合を構成します。

オプション 説明 オペレーティング システム デフォルト値
cert_authentication false に設定すると、ゲスト エージェントは sshd の TrustedUserCAKeysAuthorizedPrincipalsCommandAuthorizedPrincipalsCommandUser キーを構成しません。 Linux true

次のステップ