Récupération des gestionnaires de machine virtuelle

Utilisez l'opération GET sur l'élément api/sam/vmmanagers pour demander des informations sur les gestionnaires de machine virtuelle définis dans votre infrastructure. L'API REST renvoie plus d'informations que ce qui est affiché dans l'interface utilisateur. Elle renvoie des informations sur les gestionnaires de machine virtuelle qui sont gérés à la fois en mode central et en mode distribué, sur ceux qui étaient inactifs depuis plus de 90 jours, et sur ceux qui ont été supprimés. Elle renvoie également des informations provenant des technologies de virtualisation qui n'ont pas besoin de connexion au gestionnaire de machine virtuelle comme Xen ou KVM sans RHV-M. La portée des gestionnaires de machine virtuelle à partir desquels les données sont collectées dépend des outils VM Manager Tool installés sur les ordinateurs appartenant au groupe d'ordinateurs auquel vous êtes affecté.

Pour récupérer des informations sur les gestionnaires de machine virtuelle, vous devez disposer du droit "Gérer les gestionnaires de machine virtuelle et les serveurs".

Tableau 1. Descriptions des opérations
Détails de l'opération Description
Fonctionnement GET /api/sam/vmmanagers
Finalité Renvoie une liste de gestionnaires de machine virtuelle.
Méthode HTTP GET
URI de resources https://server_host_name:port_number/api/sam/vmmanagers?token=token
Demande Content-Type application/json
RéponseContent-Type application/json
Codes de réponse normaux HTTP
  • 200 – OK
Codes de réponse HTTP d'erreur
  • 400 – "Bad Request" si un paramètre de requête contient des erreurs ou est manquant
  • 401 – "Unauthorized" si l'utilisateur ne dispose pas du droit Gérer les gestionnaires de machine virtuelle et les serveurs
  • 403 – "Forbidden" si l'ordinateur sur lequel le VM Manager Tool central est installé n'appartient pas au groupe d'ordinateurs auquel l'utilisateur est affecté
  • 500 – "Internal Server Error" si VM Manager Tool n'est pas défini dans la base de données BigFix Inventory.

Le corps du message comprend un message d'erreur détaillé.

Attributs de réponse

Tableau 2. Attributs de réponse et leurs valeurs possibles
Attribut Valeurs possibles
deleted Indique si le gestionnaire de machine virtuelle a été supprimé de BigFix Inventory.
lastmodified Date et heure auxquelles le gestionnaire de machine virtuelle a été modifié pour la dernière fois.
login Nom d'utilisateur permettant d'accéder au gestionnaire de machine virtuelle.
protocol Le protocole de communication utilisé par le gestionnaire de machine virtuelle. L'attribut s'applique seulement pour Hyper-V.
  • 0 - WinRM
  • 1 - PowerShell
  • null - le gestionnaire de machine virtuelle n'est pas Hyper-V
sharedcredentials Indique si le gestionnaire de machine virtuelle partage ses données d'identification avec d'autres hôtes du même cluster. L'attribut s'applique seulement pour Hyper-V.
status Statut du gestionnaire de machine virtuelle.
  • -1 - Données d'identification non valides - suspendu
  • 0 - En attente
  • 1 - OK
  • 2 - échec de la connexion
  • 3 - Données d'identification non valides - tentative en cours
  • 6 - Adresse dupliquée
  • 7 - Dépassement de dELAi - suspendu
  • 8 - OK - UUID en double supprimés
  • 9 - Aucune donnée de gestionnaire de machine virtuelle
  • 98 - Inactif
  • 99 - Problème inconnu
Pour plus d'informations sur chaque statut, voir : Statuts du gestionnaire de machine virtuelle.
type Type du gestionnaire de machine virtuelle.
  • 1 - Hyper-V
  • 2 - VMware vSphere ou VMware éSX
  • 3 - RHV-M
  • 9.2.12 4 - Citrix Hypervisor (anciennement XenServer)
  • 99 - Autre. La valeur est utilisée pour les gestionnaires de machine virtuelle pour lesquels les données sont collectées à l'aide de la tâche "Exécuter l'examen de capacité sur les hôtes de virtualisation" (par exemple, Xen et KVM sans RHV-M).
url Adresse Web du gestionnaire de machine virtuelle.
vmmanagerid ID du gestionnaire de machine virtuelle.
vmmanagertoolid ID de VM Manager Tool qui collecte les informations à partir d'un gestionnaire de machine virtuelle particulier.

Exemple de conversation HTTP

Demande
GET http://localhost:9081/api/sam/vmmanagers
?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Corps de réponse (JSON)

[{
    "vmmanagerid":1,
    "protocol":null,
    "deleted":false,
    "vmmanagertoolid":1,
    "sharecredentials":false,
    "lastmodified":"2016-06-12 09:06:51.723",
    "login":"admin@internal",
    "type":3,
    "url":"https:\/\/9.156.44.146:8443\/api",
    "status":98
}]