vCenter Server 中的 API 命令可讓您執行各種管理工作。API 命令由應用裝置管理服務提供。您可以編輯時間同步化設定、監控程序與服務、進行 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 | 依識別碼取消備份工作。 |
com.vmware.appliance.recovery.backup.job.create | 啟動備份工作。 |
com.vmware.appliance.recovery.backup.job.get | 依識別碼取得備份工作的狀態。 |
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 | 取得 Direct Console 使用者介面 (DCUI TTY2) 狀態的相關資訊。 |
com.vmware.appliance.version1.access.dcui.set | 設定 Direct Console 使用者介面 (DCUI TTY2) 的啟用狀態。 |
com.vmware.appliance.version1.access.shell.get | 取得 Bash shell 狀態的相關資訊,即從受控 CLI 中存取 Bash shell。 |
com.vmware.appliance.version1.access.shell.set | 設定 Bash shell 的啟用狀態,即從受控 CLI 中存取 Bash shell。 |
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.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 組態。 |
com.vmware.appliance.version1.ntp.server.delete | 刪除 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 | 設定時間同步化組態。 |