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 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.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 配置中。 |
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 | 将所有分区的大小调整为磁盘大小的 1 倍。 |
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 | 设置时间同步配置。 |