Les commandes API de vCenter Server Appliance vous permettent d'effectuer différentes tâches administratives dans vCenter Server Appliance. Les commandes API sont fournies par le service de gestion du dispositif de vCenter Server Appliance. Vous pouvez modifier les paramètres de synchronisation de l'heure, surveiller les processus et les services, configurer les paramètres SNMP, etc.

Tableau 1. Commandes API disponibles dans vCenter Server Appliance

Commandes API

Description

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

Obtenez des informations sur l'état de l'interface de ligne de commande contrôlée basée sur la console (TTY1).

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

Définissez l'interface de ligne de commande contrôlée basée sur la console (TTY1).

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

Obtenez des informations sur l'état de l'interface DCUI (Direct Console User Interface) (DCUI TTY2).

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

Définissez l'état activé de l'interface DCUI (DCUI TTY2).

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

Obtenez des informations sur l'état de l'interpréteur de commandes de dépistage, c'est-à-dire accédez à l'interpréteur de commandes Bash depuis l'interface de ligne de commande contrôlée.

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

Définissez l'état activé de l'interpréteur de commandes de dépistage, c'est-à-dire accédez à l'interpréteur de commandes Bash depuis l'interface de ligne de commande contrôlée.

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

Obtenez l'état activé de l'interface de ligne de commande contrôlée basée sur le SSH.

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

Définissez l'état activé de l'interface de ligne de commande contrôlée basée sur le SSH.

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

Créez un nouveau compte d'utilisateur local.

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

Supprimez un compte d’utilisateur local.

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

Obtenez les informations sur le compte d'utilisateur local.

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

Répertoriez les comptes d'utilisateurs locaux.

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

Mettez à jour le mot de passe d'un utilisateur connecté ou de l'utilisateur que vous spécifiez dans le paramètre username.

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

Mettez à jour les propriétés du compte d'utilisateur local, comme son rôle, son nom complet, son état activé et son mot de passe.

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

Arrêtez un agent SNMP activé.

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

Démarrez un agent SNMP désactivé.

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

Renvoyez la configuration d'un agent SNMP.

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

Générez des clés localisées pour les communications SNMPv3 sécurisées.

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

Obtenez des informations sur les limites SNMP.

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

Restaurez les paramètres d'usine par défaut.

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

Définissez la configuration SNMP.

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

Envoyez une notification warmStart à toutes les interruptions configurées et informez les destinations (voir RFC 3418).

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

Ajoutez des domaines aux domaines de recherche DNS.

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

Obtenez une liste des domaines de recherche DNS.

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

Définissez les domaines de recherche DNS.

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

Obtenez le nom de domaine complet.

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

Définissez le nom de domaine complet.

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

Ajoutez un serveur DNS. Cette méthode échoue si vous utilisez DHCP.

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

Obtenez la configuration du serveur DNS.

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

Définissez la configuration du serveur DNS. Si l'hôte est configuré pour acquérir des serveurs DNS et le nom d'hôte en utilisant DHCP, une actualisation de DHCP est exécutée de force.

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

Ajoutez une règle de pare-feu pour accorder ou refuser l'accès depuis une adresse IP entrante.

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

Supprimez une règle spécifique à une position donnée ou supprimez toutes les règles.

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

Obtenez une liste ordonnée des adresses IP autorisées ou refusées par une règle de pare-feu.

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

Obtenez des informations sur une interface réseau particulière.

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

Obtenez une liste des interfaces réseau disponibles, notamment celles qui ne sont pas encore configurées.

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

Obtenez la configuration du réseau IPv4 pour les interfaces.

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

Obtenez la configuration du réseau IPv4 pour toutes les interfaces configurées.

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

Renouvelez la configuration du réseau IPv4 sur les interfaces. Si l'interface est configurée pour utiliser DHCP pour l'attribution d'adresse IP, le bail de l'interface sera renouvelé.

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

Définissez la configuration du réseau IPv4 pour une interface.

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

Obtenez la configuration du réseau IPv6 pour les interfaces.

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

Obtenez la configuration du réseau IPv6 pour toutes les interfaces configurées.

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

Définissez la configuration du réseau IPv6 pour une interface.

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

Ajoutez des règles de routage statique. Une destination ou un préfixe de type 0.0.0.0/0 (pour IPv4) ou ::/0 (pour IPv6) renvoie à la passerelle par défaut.

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

Supprimez des règles de routage statique.

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

Obtenez la table de routage. Une destination ou un préfixe de type 0.0.0.0/0 (pour IPv4) ou ::/0 (pour IPv6) renvoie à la passerelle par défaut.

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

Supprimez la configuration de proxy pour un protocole que vous fournissez en entrée.

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

Obtenez les informations de configuration du proxy pour tous les protocoles.

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

Définissez la configuration de proxy pour un protocole que vous fournissez en entrée.

com.vmware.appliance.version1.ntp.get

Obtenez les paramètres de configuration NTP. Si vous exécutez la commande tymesync.get, vous pouvez récupérer la méthode de synchronisation de l'heure actuelle (à l'aide de NTP ou de VMware Tools) . La commande ntp.get renvoie toujours les informations sur le serveur NTP, même lorsque la méthode de synchronisation de l'heure n'est pas définie sur NTP. Si la méthode de synchronisation n'est pas définie à l'aide de NTP, l'état de NTP est affiché comme hors service.

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

Ajoutez des serveurs NTP. Cette commande ajoute des serveurs NTP à la configuration. Si la synchronisation de l'heure est basée sur NTP, le démon NTP est redémarré pour recharger les nouveaux serveurs NTP. Sinon, cette commande ajoute simplement des serveurs à la configuration de NTP.

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

Supprimez des serveurs NTP. Cette commande supprime des serveurs NTP de la configuration. Si la méthode de synchronisation de l'heure est basée sur NTP, le démon NTP est redémarré pour recharger la nouvelle configuration NTP. Sinon, cette commande supprime simplement des serveurs de la configuration de NTP.

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

Définissez des serveurs NTP. Cette commande supprime les anciens serveurs NTP de la configuration et définit les serveurs NTP d'entrée dans la configuration. Si la synchronisation de l'heure est définie à l'aide de NTP, le démon NTP est redémarré pour recharger la nouvelle configuration NTP. Sinon, cette commande remplace simplement les serveurs de la configuration NTP avec les serveurs NTP que vous fournissez.

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

Obtenez les statistiques de CPU.

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

Obtenez la santé de la charge.

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

Obtenez les charges moyennes (supérieures à des intervalles de 1, 5 et 15 minutes).

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

Obtenez la santé de la mémoire.

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

Obtenez les statistiques de mémoire.

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

Obtenez les statistiques de réseau.

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

Obtenez les statistiques des interfaces qui sont en cours d'exécution.

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

Obtenez les statistiques de tous les processus.

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

Obtenez la santé du composant de mise à jour.

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

Obtenez les statistiques de santé du stockage.

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

Obtenez les statistiques de chaque disque logique.

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

Obtenez la santé d'échange.

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

Obtenez les statistiques d'échanges.

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

Obtenez la santé générale du système.

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

Obtenez l'état du système.

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

Obtenez l'heure du système.

com.vmware.appliance.version1.services.list

Obtenez une liste de tous les services connus.

com.vmware.appliance.version1.services.restart

Redémarrez un service.

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

Obtenez l'état d'un service.

com.vmware.appliance.version1.services.stop

Arrêtez un service.

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

Obtenez la configuration de correction basée sur URL.

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

Définissez la configuration de correction basée sur URL.

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

Obtenez la version du dispositif.

com.vmware.appliance.version1.timesync.get

Obtenez la configuration de la synchronisation du temps.

com.vmware.appliance.version1.timesync.set

Obtenez la configuration de la synchronisation.