vCenter Server Appliance の API コマンドを使用すると、vCenter Server Appliance のさまざまな管理タスクを実行できます。これらの API コマンドは、vCenter Server Appliance のアプライアンス管理サービスによって提供されます。時刻同期設定の編集、プロセスとサービスの監視、SNMP 設定のセットアップなどを実行できます。
| API コマンド | 説明 |
|---|---|
| com.vmware.appliance.health.applmgmt.get | applmgmt サービスの健全性情報を取得します。 |
| com.vmware.appliance.health.databasestorage.get | データベース ストレージの健全性情報を取得します。 |
| com.vmware.appliance.health.load.get | CPU 負荷の健全性情報を取得します。 |
| com.vmware.appliance.health.mem.get | メモリの健全性情報を取得します。 |
| com.vmware.appliance.health.softwarepackages.get | システム更新の健全性情報を取得します。 |
| com.vmware.appliance.health.storage.get | ストレージ全体の健全性情報を取得します。 |
| com.vmware.appliance.health.swap.get | スワップの健全性情報を取得します。 |
| com.vmware.appliance.health.system.get | システムの健全性情報を取得します。 |
| com.vmware.appliance.health.system.lastcheck | 前回健全性ステータスが確認された時刻を取得します。 |
| com.vmware.appliance.monitoring.list | 監視対象の項目の一覧を取得します。 |
| com.vmware.appliance.monitoring.get | 監視対象の項目の情報を取得します。 |
| com.vmware.appliance.monitoring.query | 監視対象の項目に関して一連の値を照会します。 |
| com.vmware.appliance.recovery.backup.job.cancel | バックアップ ジョブを id でキャンセルします。 |
| com.vmware.appliance.recovery.backup.job.create | バックアップ ジョブを開始します。 |
| com.vmware.appliance.recovery.backup.job.get | バックアップ ジョブのステータスを id で取得します。 |
| com.vmware.appliance.recovery.backup.job.list | バックアップ ジョブの一覧を取得します。 |
| com.vmware.appliance.recovery.backup.parts.list | バックアップ ジョブに含めることができる vCenter Server コンポーネントのリストを取得します。 |
| com.vmware.appliance.recovery.backup.parts.get | バックアップ対象に関する詳細情報を取得します。 |
| com.vmware.appliance.recovery.backup.validate | ジョブを開始せずにバックアップ ジョブのパラメータを検証します。 |
| com.vmware.appliance.recovery.restore.job.cancel | リストア ジョブをキャンセルします。 |
| com.vmware.appliance.recovery.restore.job.create | リストア ジョブを開始します。 |
| com.vmware.appliance.recovery.restore.job.get | リストア ジョブのステータスを取得します。 |
| com.vmware.appliance.recovery.restore.validate | ジョブを開始せずにリストア ジョブのリストア パラメータを検証します。 |
| com.vmware.appliance.system.uptime.get | システムの連続稼動時間を取得します。 |
| com.vmware.appliance.version1.access.consolecli.get | コンソール ベースの制御された CLI (TTY1) の状態に関する情報を取得します。 |
| com.vmware.appliance.version1.access.consolecli.set | コンソール ベースの制御された CLI (TTY1) の有効な状態を設定します。 |
| com.vmware.appliance.version1.access.dcui.get | ダイレクト コンソール ユーザー インターフェイス (DCUI TTY2) の状態に関する情報を取得します。 |
| com.vmware.appliance.version1.access.dcui.set | ダイレクト コンソール ユーザー インターフェイス (DCUI TTY2) の有効な状態を設定します。 |
| com.vmware.appliance.version1.access.shell.get | Bash シェルの状態、つまり、制御された CLI 内からの Bash シェルへのアクセスに関する情報を取得します。 |
| com.vmware.appliance.version1.access.shell.set | Bash シェルの有効な状態、つまり、制御された CLI 内からの Bash シェルへのアクセスに関する情報を設定します。 |
| com.vmware.appliance.version1.access.ssh.get | SSH ベースの制御された CLI の有効な状態を取得します。 |
| com.vmware.appliance.version1.access.ssh.set | SSH ベースの制御された CLI の有効な状態を設定します。 |
| com.vmware.appliance.version1.localaccounts.user.add | 新しいローカル ユーザー アカウントを作成します。 |
| com.vmware.appliance.version1.localaccounts.user.delete | ローカル ユーザー アカウントを削除します。 |
| com.vmware.appliance.version1.localaccounts.user.get | ローカル ユーザー アカウント情報を取得します。 |
| com.vmware.appliance.version1.localaccounts.user.list | ローカル ユーザー アカウントを一覧表示します。 |
| com.vmware.appliance.version1.localaccounts.user.password.update | ログインしているユーザー、または username パラメータで指定されたユーザーのパスワードを更新します。 |
| com.vmware.appliance.version1.localaccounts.user.set | ローカル ユーザー アカウントのプロパティ（ロール、フル ネーム、有効なステータス、パスワードなど）を更新します。 |
| com.vmware.appliance.version1.monitoring.snmp.disable | 有効な SNMP エージェントを停止します。 |
| com.vmware.appliance.version1.monitoring.snmp.enable | 無効な SNMP エージェントを開始します。 |
| com.vmware.appliance.version1.monitoring.snmp.get | SNMP エージェントの構成を返します。 |
| com.vmware.appliance.version1.monitoring.snmp.hash | セキュアな SNMPv3 通信用のローカライズされたキーを生成します。 |
| com.vmware.appliance.version1.monitoring.snmp.limits | SNMP の制限情報を取得します。 |
| com.vmware.appliance.version1.monitoring.snmp.reset | 工場出荷時のデフォルト設定をリストアします。 |
| com.vmware.appliance.version1.monitoring.snmp.set | SNMP 構成を設定します。 |
| com.vmware.appliance.version1.monitoring.snmp.stats | SNMP エージェントの診断レポートを生成します。 |
| com.vmware.appliance.version1.networking.dns.domains.add | DNS 検索ドメインにドメインを追加します。 |
| com.vmware.appliance.version1.networking.dns.domains.list | DNS 検索ドメインの一覧を取得します。 |
| com.vmware.appliance.version1.networking.dns.domains.set | DNS 検索ドメインを設定します。 |
| com.vmware.appliance.version1.networking.dns.hostname.get | 完全修飾ドメイン名を取得します。 |
| com.vmware.appliance.version1.networking.dns.hostname.set | 完全修飾ドメイン名を設定します。 |
| com.vmware.appliance.version1.networking.dns.servers.add | DNS サーバを追加します。DHCP を使用している場合、この方法は失敗します。 |
| com.vmware.appliance.version1.networking.dns.servers.get | DNS サーバ構成を取得します。 |
| com.vmware.appliance.version1.networking.dns.servers.set | DNS サーバ構成を設定します。DHCP を使用して DNS サーバとホスト名を取得するようホストが構成されている場合は、DHCP が強制的に更新されます。 |
| com.vmware.appliance.version1.networking.firewall.addr.inbound.add | 受信 IP アドレスからのアクセスを許可または拒否するファイアウォール ルールを追加します。 |
| com.vmware.appliance.version1.networking.firewall.addr.inbound.delete | 指定された位置の特定のルールまたはすべてのルールを削除します。 |
| com.vmware.appliance.version1.networking.firewall.addr.inbound.list | ファイアウォール ルールによって許可または拒否される受信 IP アドレスの順序が記載されたリストを取得します。 |
| com.vmware.appliance.version1.networking.interfaces.get | 特定のネットワーク インターフェイスに関する情報を取得します。 |
| com.vmware.appliance.version1.networking.interfaces.list | 使用可能なネットワーク インターフェイス（未構成のインターフェイスも含む）のリストを取得します。 |
| com.vmware.appliance.version1.networking.ipv4.get | インターフェイスの IPv4 ネットワーク設定を取得します。 |
| com.vmware.appliance.version1.networking.ipv4.list | すべての構成済みインターフェイスの IPv4 ネットワーク設定を取得します。 |
| com.vmware.appliance.version1.networking.ipv4.renew | インターフェイスの IPv4 ネットワーク設定を更新します。DHCP を使用して IP アドレスを割り当てるようにインターフェイスが設定されている場合は、インターフェイスのリースが更新されます。 |
| com.vmware.appliance.version1.networking.ipv4.set | インターフェイスの IPv4 ネットワークを設定します。 |
| com.vmware.appliance.version1.networking.ipv6.get | インターフェイスの IPv6 ネットワーク設定を取得します。 |
| com.vmware.appliance.version1.networking.ipv6.list | すべての構成済みインターフェイスの IPv6 ネットワーク設定を取得します。 |
| com.vmware.appliance.version1.networking.ipv6.set | インターフェイスの IPv6 ネットワーク設定を設定します。 |
| com.vmware.appliance.version1.networking.routes.add | 固定ルーティング ルールを追加します。0.0.0.0/0 （IPv4 の場合）または ::/0 （IPv6 の場合）という宛先またはプリフィックスは、デフォルト ゲートウェイを意味します。 |
| com.vmware.appliance.version1.networking.routes.delete | 固定ルーティング ルールを削除します。 |
| com.vmware.appliance.version1.networking.routes.list | ルーティング テーブルを取得します。0.0.0.0/0 （IPv4 の場合）または ::/0 （IPv6 の場合）という宛先またはプリフィックスは、デフォルト ゲートウェイを意味します。 |
| com.vmware.appliance.version1.ntp.get | NTP 設定を取得します。tymesync.get コマンドを実行すれば、（NTP または VMware Tools を使用して）現在の時刻同期方法を取得できます。ntp.get は、時刻同期方法が NTP に設定されていない場合でも、常に NTP サーバ情報を返します。NTP を使用して時刻同期方法を設定しないと、NTP ステータスはダウンと表示されます。 |
| com.vmware.appliance.version1.ntp.server.add | NTP サーバを追加します。このコマンドにより、NTP サーバを設定できます。時刻同期が NTP ベースの場合は、NTP デーモンが再起動され、新規の NTP サーバが再ロードされます。時刻同期が NTP ベース以外の場合、このコマンドにより、NTP 設定へのサーバの追加のみが実行されます。 |
| com.vmware.appliance.version1.ntp.server.delete | NTP サーバを削除します。このコマンドにより、NTP サーバの設定を削除します。時刻同期モードが NTP ベースの場合は、NTP デーモンが再起動され、新規の NTP 設定が再ロードされます。時刻同期モードが NTP ベース以外の場合、このコマンドよって実行されるのは NTP を設定したサーバの削除のみです。 |
| com.vmware.appliance.version1.ntp.server.set | NTP サーバを設定します。このコマンドにより、古い NTP サーバの設定が削除され、入力した NTP サーバが新たに設定されます。NTP を使用して時刻同期を設定すると、NTP デーモンが再起動され、新規の NTP 設定が再ロードされます。時刻同期が NTP ベース以外の場合、このコマンドにより、NTP 設定へのサーバの置換のみが実行されます。 |
| com.vmware.appliance.version1.resources.cpu.stats.get | CPU 統計情報を取得します。 |
| com.vmware.appliance.version1.resources.load.health.get | ロードの健全性を取得します。 |
| com.vmware.appliance.version1.resources.load.stats.get | （1 分、5 分、15 分間隔の）平均ロードを取得します。 |
| com.vmware.appliance.version1.resources.mem.health.get | メモリの健全性を取得します。 |
| com.vmware.appliance.version1.resources.mem.stats.get | メモリ統計情報を取得します。 |
| com.vmware.appliance.version1.resources.net.stats.get | ネットワーク統計情報を取得します。 |
| com.vmware.appliance.version1.resources.net.stats.list | 稼働中のすべてのインターフェイスのネットワーク統計情報を取得します。 |
| com.vmware.appliance.version1.resources.processes.stats.list | すべてのプロセスの統計情報を取得します。 |
| com.vmware.appliance.version1.resources.softwarepackages.health.get | 更新コンポーネントの健全性情報を取得します。 |
| com.vmware.appliance.version1.resources.storage.health.get | ストレージの健全性統計情報を取得します。 |
| com.vmware.appliance.version1.resources.storage.stats.list | 各論理ディスクのストレージ統計情報を取得します。 |
| com.vmware.appliance.version1.resources.swap.health.get | スワップの健全性を取得します。 |
| com.vmware.appliance.version1.resources.swap.stats.get | スワップの統計情報を取得します。 |
| com.vmware.appliance.version1.resources.system.health.get | システムの全般的な健全性を取得します。 |
| com.vmware.appliance.version1.resources.system.stats.get | システムのステータスを取得します。 |
| com.vmware.appliance.version1.services.list | すべての既知のサービスの一覧を取得します。 |
| com.vmware.appliance.version1.services.restart | サービスを再起動します。 |
| com.vmware.appliance.version1.services.status.get | サービスのステータスを取得します。 |
| com.vmware.appliance.version1.services.stop | サービスを停止します。 |
| com.vmware.appliance.version1.system.storage.list | パーティション マッピングするディスクを取得します。 |
| com.vmware.appliance.version1.system.storage.resize | すべてのパーティションのサイズを 100% のディスク サイズに変更します。 |
| com.vmware.appliance.version1.system.time.get | システム時刻を取得します。 |
| com.vmware.appliance.version1.system.update.get | URL ベースのパッチ適用設定を取得します。 |
| com.vmware.appliance.version1.system.update.set | URL ベースのパッチ適用設定を設定します。 |
| com.vmware.appliance.version1.system.version.get | アプライアンスのバージョンを取得します。 |
| com.vmware.appliance.version1.timesync.get | 時刻同期設定を取得します。 |
| com.vmware.appliance.version1.timesync.set | 時刻同期設定を設定します。 |
