Anhand der API-Befehle in der vCenter Server Appliance können Sie verschiedene Verwaltungsaufgaben in vCenter Server Appliance durchführen. Die API-Befehle werden vom Appliance-Verwaltungsdienst in vCenter Server Appliance bereitgestellt. Sie können die Uhrzeitsynchronisierungseinstellungen bearbeiten, Prozesse und Dienste überwachen, die SNMP-Einstellungen einrichten usw.

Tabelle 1. Verfügbare API-Befehle in vCenter Server Appliance

API-Befehl

Beschreibung

com.vmware.appliance.version1.access.consolecli.get

Ruft Informationen über den Status der konsolenbasiert gesteuerten CLI ab (TTY1).

com.vmware.appliance.version1.access.consolecli.set

Legt den Aktivierungsstatus der konsolenbasiert gesteuerten CLI fest (TTY1).

com.vmware.appliance.version1.access.dcui.get

Ruft Informationen über den Status der Benutzerschnittstelle der direkten Konsole (Direct Console User Interface, DCUI TTY2) fest.

com.vmware.appliance.version1.access.dcui.set

Legt den Aktivierungsstatus der Direct Console User Interface (DCUI TTY2) fest.

com.vmware.appliance.version1.access.shell.get

Ruft Informationen zum Status der Bash-Shell ab, greift also auf die Bash-Shell von innerhalb der gesteuerten CLI zu.

com.vmware.appliance.version1.access.shell.set

Legt den Aktivierungsstatus der Bash-Shell fest, greift also auf die Bash-Shell von innerhalb der gesteuerten CLI zu.

com.vmware.appliance.version1.access.ssh.get

Ruft den Aktivierungsstatus der SSH-basiert gesteuerten CLI ab.

com.vmware.appliance.version1.access.ssh.set

Legt den Aktivierungsstatus der SSH-basiert gesteuerten CLI fest.

com.vmware.appliance.version1.localaccounts.user.add

Erstellt ein neues lokales Benutzerkonto.

com.vmware.appliance.version1.localaccounts.user.delete

Löscht ein lokales Benutzerkonto.

com.vmware.appliance.version1.localaccounts.user.get

Ruft die Informationen des lokalen Benutzerkontos ab.

com.vmware.appliance.version1.localaccounts.user.list

Listet lokale Benutzerkonten auf.

com.vmware.appliance.version1.localaccounts.user.password.update

Aktualisiert das Kennwort eines angemeldeten Benutzers oder des Benutzers, den Sie im username-Parameter angeben.

com.vmware.appliance.version1.localaccounts.user.set

Aktualisiert Eigenschaften des lokalen Benutzerkontos wie Rolle, vollständiger Name, aktivierter Status und Kennwort.

com.vmware.appliance.version1.monitoring.snmp.disable

Beendet einen aktivierten SNMP-Agenten.

com.vmware.appliance.version1.monitoring.snmp.enable

Startet einen deaktivierten SNMP-Agenten.

com.vmware.appliance.version1.monitoring.snmp.get

Gibt eine SNMP-Agentenkonfiguration zurück.

com.vmware.appliance.version1.monitoring.snmp.hash

Generiert lokalisierte Schlüssel für sichere SNMPv3-Kommunikationen.

com.vmware.appliance.version1.monitoring.snmp.limits

Ruft Informationen zu SNMP-Beschränkungen ab.

com.vmware.appliance.version1.monitoring.snmp.reset

Setzt Einstellungen auf Werkseinstellungen zurück.

com.vmware.appliance.version1.monitoring.snmp.set

Legt die SNMP-Konfiguration fest.

com.vmware.appliance.version1.monitoring.snmp.test

Sendet eine warmStart-Benachrichtigung an alle konfigurierten Trap- und Inform-Ziele (siehe RFC 3418).

com.vmware.appliance.version1.networking.dns.domains.add

Fügt Domänen zu DNS-Suchdomänen hinzu.

com.vmware.appliance.version1.networking.dns.domains.list

Ruft eine Liste der DNS-Suchdomänen ab.

com.vmware.appliance.version1.networking.dns.domains.set

Legt DNS-Suchdomänen fest.

com.vmware.appliance.version1.networking.dns.hostname.get

Ruft den vollqualifizierten Domänennamen ab.

com.vmware.appliance.version1.networking.dns.hostname.set

Legt den vollqualifizierten Domänennamen fest.

com.vmware.appliance.version1.networking.dns.servers.add

Fügt einen DNS-Server hinzu. Diese Methode schlägt fehl, wenn Sie DHCP verwenden.

com.vmware.appliance.version1.networking.dns.servers.get

Ruft die DNS-Serverkonfiguration ab.

com.vmware.appliance.version1.networking.dns.servers.set

Legt die DNS-Serverkonfiguration fest. Wenn der Host zum Abrufen der DNS-Server und des Hostnamens per DHCP konfiguriert ist, wird eine DHCP-Aktualisierung erzwungen.

com.vmware.appliance.version1.networking.firewall.addr.inbound.add

Fügt eine Firewall-Regel hinzu, um Zugriff von einer eingehenden IP-Adresse zuzulassen oder zu verweigern.

com.vmware.appliance.version1.networking.firewall.addr.inbound.delete

Löscht eine spezifische Regel an einer bestimmten Position oder löscht alle Regeln.

com.vmware.appliance.version1.networking.firewall.addr.inbound.list

Ruft eine sortierte Liste der eingehenden IP-Adressen ab, die von einer Firewall-Regel zugelassen oder verweigert werden.

com.vmware.appliance.version1.networking.interfaces.get

Ruft Informationen über eine bestimmte Netzwerkschnittstelle ab.

com.vmware.appliance.version1.networking.interfaces.list

Ruft eine Liste der verfügbaren Netzwerkschnittstellen ab, einschließlich der noch nicht konfigurierten.

com.vmware.appliance.version1.networking.ipv4.get

Ruft die IPv4-Netzwerkkonfiguration für Schnittstellen ab.

com.vmware.appliance.version1.networking.ipv4.list

Ruft die IPv4-Netzwerkkonfiguration für alle konfigurierten Schnittstellen ab.

com.vmware.appliance.version1.networking.ipv4.renew

Erneuert die IPv4-Netzwerkkonfiguration an Schnittstellen. Wenn die Schnittstelle für die Verwendung von DHCP für die IP-Adressenzuweisung konfiguriert ist, wird der Lease der Schnittstelle verlängert.

com.vmware.appliance.version1.networking.ipv4.set

Legt die IPv4-Netzwerkkonfiguration für eine Schnittstelle fest.

com.vmware.appliance.version1.networking.ipv6.get

Ruft die IPv6-Netzwerkkonfiguration für Schnittstellen ab.

com.vmware.appliance.version1.networking.ipv6.list

Ruft die IPv6-Netzwerkkonfiguration für alle konfigurierten Schnittstellen ab.

com.vmware.appliance.version1.networking.ipv6.set

Legt die IPv6-Netzwerkkonfiguration für eine Schnittstelle fest.

com.vmware.appliance.version1.networking.routes.add

Fügt statische Routing-Regeln hinzu. Ein Ziel/Präfix des Typs „0.0.0.0/0“ (für IPv4) oder „::/0“ (für IPv6) bezieht sich auf das Standardgateway.

com.vmware.appliance.version1.networking.routes.delete

Löscht statische Routing-Regeln.

com.vmware.appliance.version1.networking.routes.list

Ruft die Routing-Tabelle ab. Ein Ziel/Präfix des Typs „0.0.0.0/0“ (für IPv4) oder „::/0“ (für IPv6) bezieht sich auf das Standardgateway.

com.vmware.appliance.version1.networking.proxy.delete

Löscht die Proxy-Konfiguration für ein Protokoll, das Sie als Eingabe bereitstellen.

com.vmware.appliance.version1.networking.proxy.get

Ruft Proxy-Konfigurationsdaten für alle Protokolle ab.

com.vmware.appliance.version1.networking.proxy.set

Legt die Proxy-Konfiguration für ein Protokoll fest, das Sie als Eingabe bereitstellen.

com.vmware.appliance.version1.ntp.get

Ruft NTP-Konfigurationseinstellungen ab. Wenn Sie den tymesync.get-Befehl ausführen, können Sie die aktuelle Uhrzeitsynchronisierungsmethode (anhand von NTP oder VMware Tools) abrufen. Der ntp.get-Befehl gibt immer die NTP-Serverinformationen zurück, selbst wenn die Uhrzeitsynchronisierungsmethode nicht auf NTP festgelegt ist. Wenn die Uhrzeitsynchronisierungsmethode nicht für die Verwendung von NTP festgelegt ist, wird der NTP-Status als heruntergefahren angezeigt.

com.vmware.appliance.version1.ntp.server.add

Fügt NTP-Server hinzu. Dieser Befehl fügt der Konfiguration NTP-Server hinzu. Wenn die Uhrzeitsynchronisierung NTP-basiert ist, wird der NTP-Daemon neu gestartet, um die neuen NTP-Server zu laden. Andernfalls fügt der Befehl einfach Server zur NTP-Konfiguration hinzu.

com.vmware.appliance.version1.ntp.server.delete

Löscht NTP-Server. Dieser Befehl löscht NTP-Server aus der Konfiguration. Wenn die Uhrzeitsynchronisierung NTP-basiert ist, wird der NTP-Daemon neu gestartet, um die neue NTP-Konfiguration zu laden. Andernfalls löscht der Befehl einfach Server aus der NTP-Konfiguration.

com.vmware.appliance.version1.ntp.server.set

Legt NTP-Server fest. Dieser Befehl löscht alte NTP-Server aus der Konfiguration und richtet die Eingabe-NTP-Server in der Konfiguration ein. Wenn die Uhrzeitsynchronisierung anhand von NTP festgelegt wird, wird der NTP-Daemon neu gestartet, um die neue NTP-Konfiguration zu laden. Andernfalls ersetzt dieser Befehl nur die Server in der NTP-Konfiguration durch die als Eingabe bereitgestellten NTP-Server.

com.vmware.appliance.version1.resources.cpu.stats.get

Ruft CPU-Statistiken ab.

com.vmware.appliance.version1.resources.load.health.get

Ruft den Lastzustand ab.

com.vmware.appliance.version1.resources.load.stats.get

Ruft Lastdurchschnittswerte ab (in Intervallen von 1, 5 und 15 Minuten).

com.vmware.appliance.version1.resources.mem.health.get

Ruft den Zustand des Arbeitsspeichers ab.

com.vmware.appliance.version1.resources.mem.stats.get

Ruft Arbeitsspeicherstatistiken ab.

com.vmware.appliance.version1.resources.net.stats.get

Ruft Netzwerkstatistiken ab.

com.vmware.appliance.version1.resources.net.stats.list

Ruft Netzwerkstatistiken für alle laufenden Schnittstellen ab.

com.vmware.appliance.version1.resources.processes.stats.list

Ruft Statistiken aller Prozesse ab.

com.vmware.appliance.version1.resources.softwarepackages.health.get

Ruft den Zustand der Update-Komponente ab.

com.vmware.appliance.version1.resources.storage.health.get

Ruft Speicherzustandsstatistiken ab.

com.vmware.appliance.version1.resources.storage.stats.list

Ruft Speicherstatistiken für jede logische Festplatte ab.

com.vmware.appliance.version1.resources.swap.health.get

Ruft den Auslagerungszustand ab.

com.vmware.appliance.version1.resources.swap.stats.get

Ruft Auslagerungsstatistiken ab.

com.vmware.appliance.version1.resources.system.health.get

Ruft den Gesamtzustand des Systems ab.

com.vmware.appliance.version1.resources.system.stats.get

Ruft den Systemstatus ab.

com.vmware.appliance.version1.resources.system.time.get

Ruft die Systemuhrzeit ab.

com.vmware.appliance.version1.services.list

Ruft die Liste aller bekannten Dienste ab.

com.vmware.appliance.version1.services.restart

Startet einen Dienst neu.

com.vmware.appliance.version1.services.status.get

Ruft den Status eines Dienstes ab.

com.vmware.appliance.version1.services.stop

Beendet einen Dienst.

com.vmware.appliance.version1.system.update.get

Ruft die URL-basierte Patch-Konfiguration ab.

com.vmware.appliance.version1.system.update.set

Legt die URL-basierte Patch-Konfiguration fest.

com.vmware.appliance.version1.system.version.get

Ruft die Version der Appliance ab.

com.vmware.appliance.version1.timesync.get

Ruft die Uhrzeitsynchronisierungskonfiguration ab.

com.vmware.appliance.version1.timesync.set

Legt die Uhrzeitsynchronisierungskonfiguration fest.