Ajout et mise à jour de gestionnaires de machine virtuelle

Pour ajouter ou mettre à jour des gestionnaires de machine virtuelle, utilisez l'opération PUT sur l'élément api/sam/vmmanagers. Vous ne pouvez effectuer ces actions que pour les gestionnaires de machine virtuelle qui sont gérés en mode central.

Pour ajouter ou mettre à jour des gestionnaires de machine virtuelle, les conditions suivantes doivent être remplies :
  • Vous devez disposer du droit "Gérer les gestionnaires de machine virtuelle et les serveurs"
  • Le groupe d'ordinateurs auquel vous êtes affecté doit contenir l'ordinateur sur lequel l'instance centrale de VM Manager Tool est installée
Tableau 1. Descriptions des opérations
Détails de l'opération Description
Fonctionnement PUT api/sam/vmmanagers
Finalité Ajoute un nouveau gestionnaire de machine virtuelle ou modifie un gestionnaire de machine virtuelle existant.
Méthode HTTP PUT
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 code peut également indiquer un problème inconnu pour lequel il faudra contacter le support BigFix.
Remarque : La barre oblique inversée est un caractère réservé et ne peut pas être utilisée dans JSON. Il doit être correctement échappé pour être utilisé dans les chaînes. Remplacez la barre oblique inversée par \\. Cela s'applique à toutes les zones de l'API.

Attributs de requête

Tableau 2. Attributs de requête
Attribut Description
login Nom d'utilisateur permettant d'accéder au gestionnaire de machine virtuelle.
password Mot de passe permettant d'accéder au gestionnaire de machine virtuelle. Le mot de passe est chiffré après son envoi.
protocol Le protocole de communication utilisé par le gestionnaire de machine virtuelle. L'attribut s'applique seulement pour Hyper-V.
  • 0 - WinRM
  • 1 - PowerShell
sharecredentials 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.
  • true - le gestionnaire de machine virtuelle partage les données d'identification et il n'est pas nécessaire de les indiquer
  • false - le gestionnaire de machine virtuelle ne partage pas les données d'identification
type Type du gestionnaire de machine virtuelle.
  • 1 - Hyper-V
  • 2 - vCenter
  • 3 - RHV-M
  • 9.2.12 4 - Citrix Hypervisor (anciennement XenServer)
url Adresse Web du gestionnaire de machine virtuelle. Vous pouvez indiquer une adresse URL complète, un nom d'hôte ou une adresse IP. L'URL par défaut diffère en fonction du type de virtualisation.
  • vCenter
    • https://<vCenter_IP_address>/sdk/vimService.wsdl
  • RHV-M
    • https://<RHV-M_IP_address>/ovirt-engine/api
  • Hyper-V
    • https://<Hyper-V_IP_address>/wsman
vmmanagerid ID du gestionnaire de machine virtuelle que vous voulez modifier. Pour obtenir l'ID, utilisez l'API REST pour la récupération des gestionnaires de machine virtuelle.
vmmanagertoolid ID de VM Manager Tool qui collecte les données du gestionnaire de machine virtuelle que vous voulez modifier. Pour obtenir l'ID, utilisez l'API REST pour la récupération des gestionnaires de machine virtuelle.

Exemple de conversation HTTP - ajout d'un gestionnaire de machine virtuelle

Pour ajouter un gestionnaire de machine virtuelle, renseignez les attributs suivants :
  • login
  • password
  • url
  • type
Demande
PUT http://localhost:9081/api/sam/vmmanagers
?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
[
    {
        "login":"user1",
        "password":"vZaW1Ve6",
        "url":"192.0.2.24",
        "type":2
    }
]
Réponse
200 OK

Exemple de conversation HTTP - modification d'un gestionnaire de machine virtuelle

Pour modifier un gestionnaire de machine virtuelle existant, renseignez les attributs suivants :
  • login
  • password
  • url
  • type
  • vmmanagerid
  • vmmanagertoolid
Important : Tous les attributs doivent être renseignés dans la requête, peu importe le nombre d'attributs que vous voulez modifier.
Demande
PUT http://localhost:9081/api/sam/vmmanagers
?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
[
    {
        "vmmanagerid":1,
        "vmmanagertoolid":1,
        "login":"user1",
        "password":"vZaW1Ve6",
        "url":"192.0.2.24",
        "type":3
    }
]
Réponse
200 OK