Machine Translated by Google

Guide de programmation API

04 août 2021
vRealize Operations Manager 8.4
Machine Translated by Google

Guide de programmation API

Vous trouverez la documentation technique la plus récente sur le site Web de VMware à l'adresse suivante :

[Link]

VMware, Inc.
3401, avenue Hillview
Palo Alto, Californie 94304
[Link]

©
Droits d'auteur © 2021 VMware, Inc. Tous droits réservés. Informations relatives aux droits d'auteur et aux marques de commerce.

VMware, Inc. 2
Machine Translated by Google

Contenu

1 À propos de ce guide de programmation 4

2 Comprendre l'API vRealize Operations Manager 5

Fonctionnement de l'API vRealize Operations Manager 5

Aperçu du flux de travail client 6

Requêtes REST de l'API vRealize Operations Manager 7

Réponses REST de l'API vRealize Operations Manager 9

Utilisation de l'API avec vRealize Operations Manager 10

3 Premiers pas avec l'API 12

Obtenir un jeton d'authentification 12

Trouvez le type d'adaptateur et le type d'objet 14

Générer une liste de toutes les métriques pour l'objet 16

4 Configuration d'une instance d'adaptateur 18

Résumé de la configuration d'une instance d'adaptateur : requêtes 18

Identifier la solution et ses adaptateurs 19

Identifier les types d'objets requis pour l'adaptateur 21

Créer l'instance d'adaptateur 22

Fournir une preuve de validité du certificat 26

Démarrer la surveillance de la nouvelle instance d'adaptateur 29

VMware, Inc. 3
Machine Translated by Google

1
À propos de ce guide de programmation

Le guide de programmation de l'API vRealize Operations Manager fournit des informations sur les API REST
de vRealize Operations Manager, notamment sur la manière d'utiliser les ressources de l'API REST, de
s'authentifier et de construire des appels d'API REST.

Public cible
Ces informations sont destinées aux administrateurs et aux programmeurs souhaitant configurer et gérer
vRealize Operations Manager par programmation via l'API REST de vRealize Operations Manager. Ce guide se
concentre sur les cas d'utilisation courants.

VMware, Inc. 4
Machine Translated by Google

2
Comprendre vRealize
API du gestionnaire d'opérations

Les développeurs peuvent utiliser l'API pour créer des clients interactifs de vRealize Operations Manager. L'API suit le modèle
REST et est accessible à tous les utilisateurs disposant d'une licence.

Les clients de vRealize Operations Manager communiquent avec le serveur via HTTP, échangeant des représentations des
objets vRealize Operations Manager. Ces représentations prennent la forme d'éléments JSON ou XML. Vous utilisez des requêtes
HTTP GET pour récupérer la représentation actuelle d'un objet, des requêtes HTTP POST et PUT pour créer ou modifier un
objet, et des requêtes HTTP DELETE pour supprimer un objet.

Ce chapitre aborde les sujets suivants :

n Comment fonctionne l'API de vRealize Operations Manager

n Aperçu du flux de travail client

Utilisation de l'API avec vRealize Operations Manager

Fonctionnement de l'API vRealize Operations Manager

Vous utilisez un navigateur Web pour communiquer avec le moteur d'analyse vRealize Operations Manager, soit via l'interface
utilisateur du produit, soit via des appels API.

Figure 2­1. Architecture simplifiée de vRealize Operations Manager

Objet API
Inventaire Navigateur Web Client

Produit
Repos Locataire
Adaptateur Utilisateur
API Application
Interface

vRealize Operations Manager Analytics Engine

VMware, Inc. 5
Machine Translated by Google

Guide de programmation API

L'instance de l'adaptateur collecte les données des objets de votre environnement surveillé. Le moteur d'analyse de vRealize
Operations Manager traite ces données et affiche le modèle complet dans l'interface graphique.

Pourquoi utiliser l'API

L'API est particulièrement utile lorsqu'il est nécessaire d'automatiser un flux de travail bien défini, comme par exemple :

Il s'agit de répéter les mêmes tâches pour configurer le contrôle d'accès des nouveaux utilisateurs de vRealize Operations
Manager. L'API est également utile pour interroger le référentiel de données de vRealize Operations Manager, notamment pour
récupérer les données de ressources spécifiques de votre environnement virtuel. De plus, vous pouvez l'utiliser pour extraire toutes
les données du référentiel de données de vRealize Operations Manager et les charger dans un système d'analyse externe.

Terminologie de vRealize Operations Manager

La syntaxe XML utilisée pour décrire les objets d'un adaptateur correspond à la syntaxe du code API, mais diffère de celle de
l'interface utilisateur. Les termes suivants apparaissent dans l'interface utilisateur. La description de chaque terme est accompagnée de
la syntaxe XML correspondante.
Appel API.

Adaptateur Définit l'adaptateur utilisé pour détecter des types d'objets spécifiques. Par exemple, l'adaptateur vCenter détecte les objets
types connectés aux datacenters vSphere. L'adaptateur AWS détecte les services et objets AWS.

Syntaxe XML : adapterkinds.

Types d'objets : Classe d'entités représentant des objets ou des sources d'information. Les objets transmettent des données au moteur d'analyse de vRealize
Operations Manager. Les machines virtuelles, les banques de données et les systèmes hôtes sont des exemples de types d'objets définis
dans un modèle d'adaptateur vCenter.

Syntaxe XML : types de ressources.

Aperçu du flux de travail client

Les clients de l'API vRealize Operations Manager implémentent un flux de travail REST, effectuant des requêtes HTTP au serveur et
récupérant les informations dont ils ont besoin à partir des réponses du serveur.

À propos de REST

REST, acronyme de Representational State Transfer (Transfert d'état représentationnel), décrit un style architectural
caractéristique des programmes qui utilisent le protocole HTTP (Hypertext Transfer Protocol) pour échanger des
représentations sérialisées d'objets entre un client et un serveur. Dans l'API de vRealize Operations Manager, ces représentations
sont des documents JSON ou XML.

Dans un flux de travail REST, les représentations des objets sont échangées entre un client et un serveur, partant du principe qu'aucune
des parties n'a besoin de connaître l'objet autrement que par les informations fournies dans une requête ou une réponse unique. Les
URL où ces documents sont accessibles persistent généralement au­delà de la durée de vie de la requête ou de la réponse qui les
contient.

VMware, Inc. 6
Machine Translated by Google

Guide de programmation API

Flux de travail d'API REST

Les applications conçues pour utiliser une API REST utilisent des requêtes HTTP, souvent exécutées par un script ou un autre
langage de haut niveau, afin d'effectuer des appels de procédure distante permettant de créer, récupérer, mettre à jour ou supprimer
des objets définis par l'API. Dans l'API REST de vRealize Operations Manager, ces objets sont définis par un ensemble de schémas
XML. Les opérations elles­mêmes sont des requêtes HTTP et sont donc génériques pour tous les clients HTTP.

Pour écrire une application cliente d'API REST, il vous suffit de comprendre le protocole HTTP et la sémantique de JSON ou XML,
le format de transfert utilisé par l'API vRealize Operations Manager.
Pour utiliser efficacement l'API dans un tel client, vous devez vous familiariser avec les concepts suivants.

n L'ensemble des objets pris en charge par l'API et ce qu'ils représentent.

n Comment l'API représente ces objets.

n Comment un client fait référence à un objet sur lequel il souhaite opérer.

La documentation de l'API contient la liste complète des requêtes API. Voir À propos de la documentation de référence du schéma.

Requêtes REST de l'API vRealize Operations Manager

Pour récupérer les représentations des objets, les clients effectuent des requêtes HTTP vers les références des objets.

Sécurité
La liaison HTTP entre un client API et un serveur est établie via SSL. Les clients API se configurent.
Authentification par jeton pour communiquer avec le serveur.

Figure 2­2. Scénario : Fournir les identifiants de l’utilisateur pour obtenir des détails sur l’alerte portant l’ID 123

VMware, Inc. 7
Machine Translated by Google

Guide de programmation API

L'authentification par jeton consiste à envoyer une requête POST de connexion au serveur API de vRealize Operations Manager, en
fournissant des informations d'identification utilisateur valides afin d'obtenir un jeton d'authentification. L'exemple suivant illustre
un scénario d'authentification par jeton.

1 Vous obtenez des informations d'identification utilisateur valides pour votre instance vRealize Operations Manager.

2. Envoyez une requête POST au point de terminaison REST pour l'authentification.

[Link]

Le corps de la requête comprend le nom d'utilisateur, le mot de passe et la source d'authentification.

3 Dans le corps de la réponse, le point de terminaison renvoie le jeton, la date d'expiration et l'heure.

4 Pour toute communication ultérieure, vous incluez l'objet token dans l'en­tête Authorization avec le
format :

Autorisation : vRealizeOpsToken < jeton vROps >

Sinon, si vous avez obtenu le jeton à partir d'une source SSO, l'en­tête d'autorisation est de
le format :

Autorisation : SSO2Token < SSO_SAML_TOKEN >

5 Vous pouvez invalider le jeton avant sa date et heure d'expiration en envoyant une requête POST
vers le point de terminaison de déconnexion.

POST [Link]

En­têtes de requête
Les en­têtes HTTP suivants sont généralement inclus dans les requêtes API :

Accept­Language Pour spécifier la langue souhaitée dans les réponses, utilisez l' en­tête de requête Accept­Language . Message
Les chaînes de caractères des réponses de type ErrorType sont localisées. Pour demander une réponse avec des chaînes de caractères
localisées en français, utilisez l'en­tête suivant :

Accept­Language: fr­FR

Autorisation Toute requête de création de session API doit inclure un en­tête d'autorisation conforme aux exigences du fournisseur d'identité utilisé
par votre organisation.

Type de contenu Les requêtes comportant un corps doivent inclure un en­tête HTTP Content­Type approprié .

Pour un corps de requête en XML, l'en­tête doit inclure Content­Type : application/xml

Pour un corps de requête au format JSON, l'en­tête doit inclure Content­Type : application/json

Accepter Pour spécifier le format de réponse souhaité , inclure l' en­tête de requête Accept .

Pour une réponse au format XML, l'en­tête doit inclure Accept: application/xml

Pour une réponse au format JSON, l'en­tête doit inclure Accept: application/json

VMware, Inc. 8
Machine Translated by Google

Guide de programmation API

Corps de requête en XML

Pour un corps de requête rédigé en XML, vRealize Operations Manager utilise un analyseur XML de validation qui exige que les
éléments du corps de la requête respectent le schéma en termes d'ordre et de nombre. Les corps de requête sont rejetés comme invalides
s'ils ne répondent pas aux critères suivants :

Les attributs d'espace de noms XML doivent être fournis pour tous les espaces de noms représentés par des éléments dans

la demande.

Si plusieurs espaces de noms sont représentés dans la requête, les attributs d'espace de noms XML doivent inclure un préfixe d'identification, et ce préfixe

doit être utilisé avec tous les éléments de cet espace de noms.

espace de noms.

Tous les éléments obligatoires doivent figurer dans le corps des requêtes. Tous les éléments qui apparaissent dans la requête

Les corps doivent apparaître dans l'ordre établi par le schéma et avec un contenu conforme à la contrainte de type spécifiée par le

schéma.

Réponses de l'API REST de vRealize Operations Manager

Toutes les réponses comportent un code d'état HTTP et, sauf si ce code est 204 (Aucun contenu), un en­tête Accept. Le contenu de la
réponse dépend de la requête : certaines réponses contiennent un corps de document, d'autres uniquement une URL, et d'autres encore

sont vides.

Codes de réponse HTTP

Un client API peut s'attendre à un sous­ensemble de codes d'état HTTP dans une réponse.

Tableau 2­1. Codes d'état HTTP renvoyés par l'API

Code d'état Description du statut

200 OK La requête est valide et a été traitée. La réponse comprend un

document.

201 Créés La requête est valide. L'objet demandé a été créé et se trouve à
l'URL spécifiée dans l'emplacement.
en­tête.

202 Acceptés La requête est valide et une tâche a été créée pour la traiter. Cette
réponse est généralement accompagnée d'un TaskStatus.
élément .

204 Aucun contenu La requête est valide et a été traitée. La réponse ne contient pas
de corps.

400 Mauvaise requête Le corps de la requête est mal formé, incomplet ou autre.
invalide.

401 Non autorisé Échec de la connexion ou expiration du jeton d'authentification.

403 Interdit L'utilisateur n'est pas authentifié ou ne dispose pas des privilèges
suffisants pour accéder à un ou plusieurs objets spécifiés dans le
demande.

404 Introuvable L'objet spécifié dans la requête est introuvable.

VMware, Inc. 9
Machine Translated by Google

Guide de programmation API

Tableau 2­1. Codes d'état HTTP renvoyés par l'API (suite)

Code d'état Description du statut

405 Méthode non autorisée La méthode HTTP spécifiée dans la requête n'est pas prise en
charge pour cet objet.

406 Non acceptable La ressource identifiée par la requête n'est pas en mesure de générer une
réponse du type spécifié dans l' en­tête Accept de la requête .

415 Type de média non pris en charge La ressource identifiée par la requête ne prend pas en charge une requête du
type de contenu et de la méthode HTTP spécifiés.

422 Introuvable Indique généralement une URL de requête ou un corps de requête mal
formé.

429 Trop de requêtes Un client a envoyé trop de requêtes ou plusieurs clients envoient trop de requêtes
simultanées et le serveur est incapable de les traiter en raison des limites de débit.

Pour contourner ce problème, essayez de renvoyer la requête plus tard.

Erreur interne du serveur (500) La demande a été reçue mais n'a pas pu être finalisée.
en raison d'une erreur interne sur le serveur.

503 Service indisponible Le serveur est actuellement incapable de traiter la requête en raison d'une
condition temporaire telle qu'une saturation des ressources ou
Maintenance du serveur.

Délai d'attente de la passerelle : erreur 504 Le serveur, agissant comme passerelle ou proxy, n'a pas reçu de
réponse en temps voulu du serveur en amont spécifié par l'URL de la requête.

Utilisation de l'API avec vRealize Operations Manager

Vous pouvez utiliser un navigateur ou un programme client HTTP pour envoyer des requêtes et recevoir des réponses.

Programmes clients REST

Toute application cliente capable d'envoyer des requêtes HTTPS convient au développement d'applications REST avec l'API
vRealize Operations Manager. Des plug­ins clients REST sont disponibles pour la plupart des navigateurs et de nombreux
environnements de développement intégrés (IDE). Les logiciels libres suivants sont couramment utilisés :

n cURL. [Link]

Application Postman. [Link]

De plus, VMware fournit des liaisons client spécifiques à chaque langage pour l'API vRealize Operations Manager. Voir À
propos du schéma de référence.

À propos de la référence du schéma

La documentation de l'API REST de vRealize Operations Manager contient des informations de référence pour tous les
éléments, types, requêtes et opérations de l'API vRealize Operations Manager. Elle comprend également :
les fichiers de définition de schéma.

VMware, Inc. 10
Machine Translated by Google

Guide de programmation API

Une documentation API basée sur Swagger est disponible avec le produit, permettant d'effectuer des appels d'API
REST directement depuis la page d'accueil.

Pour accéder à la documentation de l'API, utilisez l'URL de votre instance vRealize Operations Manager.
Par exemple, si l'URL de votre instance est [Link] la documentation de l'API est disponible à
l'adresse suivante : [Link]

Des liaisons client spécifiques à chaque langage sont disponibles à partir de :

[Link]

À propos des exemples d'API de vRealize Operations Manager

Tous les exemples incluent des requêtes et des réponses HTTP. Ils illustrent le flux de travail et le contenu associés
à des opérations telles que la création et l'interrogation d'informations sur les objets de votre environnement surveillé.

Les exemples de corps de requêtes sont au format JSON. Les en­têtes de requête requis par l'API vRealize
Operations Manager sont inclus dans les exemples de requêtes qui ne sont pas des fragments d'un exemple plus long.

La plupart des exemples de réponses ne présentent que les éléments et attributs pertinents à l'opération en
question. Les points de suspension (...) indiquent des éléments omis dans le corps de la réponse.

VMware, Inc. 11
Machine Translated by Google

3
Premiers pas avec l'API

Les clients API et les serveurs vRealize Operations Manager communiquent via HTTPS, en échangeant des représentations XML des
objets API.

Cet exemple simple de flux de travail d'API REST montre comment obtenir une liste de toutes les métriques pour un type d'objet de
machine virtuelle inclus dans la définition du modèle de l'adaptateur VMware vCenter®.
L'API vous permet d'obtenir la liste complète des métriques disponibles pour tout type d'objet.

Ce chapitre aborde les sujets suivants :

n Acquérir un jeton d'authentification

n Trouvez le type d'adaptateur et le type d'objet

n Générer une liste de toutes les métriques pour l'objet

Obtenir un jeton d'authentification

vRealize Operations Manager exige que les requêtes API soient authentifiées. La première étape de ce processus consiste à…
La procédure consiste à obtenir un jeton d'authentification.

Pour obtenir un jeton d'authentification, la requête de connexion fournit les informations d'identification de l'utilisateur au format
requis par l'authentification HTTP de base. Dans cet exemple, l'utilisateur se connecte à une instance de vRealize Operations
Manager via l'URL [Link]

Remarque : Cet exemple utilise l’authentification par jeton. Pour plus d’informations concernant
mécanismes d'authentification, voir Sécurité.

Avec authSource, vous pouvez importer et authentifier les informations des utilisateurs et des groupes d'utilisateurs hébergés sur une
autre machine. Par exemple, vous pouvez authentifier des utilisateurs à partir de LDAP, Active Directory, VMware Identity
Manager, Single Sign­On, etc. Lors de l'importation d'informations de compte utilisateur hébergées sur une autre machine, vous devez
définir les critères d'importation.
de la machine source.

Après avoir créé une source d'authentification, vous pouvez l'utiliser pour obtenir un jeton en spécifiant son nom. Le type de source
d'authentification par défaut est LOCAL.

VMware, Inc. 12
Machine Translated by Google

Guide de programmation API

Prérequis

Sécurisez un canal entre le navigateur Web et le serveur vRealize Operations Manager.

Ouvrez un navigateur et saisissez l'URL d'une instance de vRealize Operations Manager, par exemple :

[Link]

Le système vous avertit que votre connexion n'est pas privée. Cliquez pour confirmer l'exception de sécurité et établir une
connexion SSL.

Vérifiez que vous pouvez accéder aux API. Saisissez l'URL de votre instance vRealize Operations Manager en ajoutant suite­api/docs/rest/[Link]

à la fin, par exemple :

[Link]

Vérifiez que vous disposez des identifiants de connexion d'un utilisateur de votre vRealize Operations Manager.
exemple.

Procédure

1. Envoyez une requête POST à l'URL de connexion pour obtenir un jeton.

POST [Link]

Voir la requête et la réponse de connexion.

2. Examinez la réponse.

Une requête réussie renvoie un jeton d'autorisation d'opérations , que vous devez inclure dans les requêtes API
suivantes.

Exemple : Requête et réponse de connexion

Cet exemple illustre une requête et une réponse pour un utilisateur dont le nom d'utilisateur est : vRealize­user et le mot de passe :
vRealize­dummy­password.

En­tête de la requête :

POST [Link]
Type de contenu : application/json
Accepter : application/json

Corps de la requête au format JSON :

{
"nom d'utilisateur" : "utilisateur vRealize",
"mot de passe" : "vRealize­dummy­password"
}

VMware, Inc. 13
Machine Translated by Google

Guide de programmation API

Réponse au format JSON :

200 OK

{
"token": "8f868cca­27cc­43d6­a838­c5467e73ec45::77cea9b2­1e87­490e­b626­e878beeaa23b", "validity":
1470421325035, "expiresAt":
"Friday, August 5, 2016 18:22:05 UTC", "roles": []

Le code de réponse indique si la requête a abouti ou pourquoi elle a échoué.

Si la requête aboutit, le serveur renvoie le code de réponse HTTP 200 (OK) et un jeton d'autorisation d'opérations réutilisable,
valable six heures. Ce jeton doit être inclus dans chaque requête API ultérieure.

Si l'en­tête d'autorisation est absent de la requête, le serveur renvoie un code de réponse HTTP
403.

Si les informations d'identification fournies dans l'en­tête Authorization sont invalides, le serveur renvoie le code de réponse HTTP 401.

Trouvez le type d'adaptateur et le type d'objet.

Votre instance vRealize Operations Manager comprend plusieurs types d'adaptateurs. Pour identifier le type d'adaptateur de vCenter,
effectuez une requête GET afin d'obtenir la liste de tous les types d'adaptateurs. La réponse de l'API inclut tous les types d'objets
surveillés par l'adaptateur.

Prérequis

Vérifiez que vous êtes connecté à l'instance vRealize Operations Manager.

Procédure

1 Effectuez une requête GET pour tous les types d'adaptateurs.

GET [Link]

2 Examinez la réponse pour trouver l'adaptateur vCenter et la liste des types d'objets surveillés.

Consultez la section « Réponse » de la rubrique « Déterminer le type d’adaptateur et les types d’objets pour l’adaptateur
vCenter ».

Exemple : Déterminer le type d’adaptateur et les types d’objets pour

l’adaptateur vCenter
Cet exemple détermine le type d'adaptateur pour l'adaptateur vCenter et tous les types d'objets inclus dans la définition du modèle
d'adaptateur.

VMware, Inc. 14
Machine Translated by Google

Guide de programmation API

En­tête de la requête :

GET [Link]
Type de contenu : application/json
Autorisation : vRealizeOpsToken <Accept : jeton vROps >
application/json

Où vROps_token est le jeton que vous avez obtenu de la réponse dans Acquérir un
Jeton d'authentification.

Extrait de la réponse au format JSON pour l'adaptateur vCenter :

200 OK

{
"key": "VMware",
"name": "Adaptateur vCenter",
"description": "Fournit les informations de connexion et les identifiants requis...", "adapterKindType": "GENERAL",
"describeVersion": 573, "identifiers": [],
"resourceKinds": [

"Ressource de calcul en cluster",

"Ressource de calcul",
"CustomDatacenter",
"Centre de données",

"Datastore",
"StoragePod",
"Dossier de stockage de données",

"État de l'entité VM",

"Dossier",
"HostFolder",
"HostSystem",
"DossierRéseau",
"Réseau de ressources",

"Instance VMwareAdapter",
"Machine virtuelle",
"VMFolder",
"DistributedVirtualPortgroup",
"VmwareDistributedVirtualSwitch", "vSphere
World" ],

...
}

Pour l'adaptateur vCenter, la clé adapter­kind est VMWARE. Les resourceKinds correspondent aux types d'objets
surveillés par l'adaptateur vCenter. Pour le type d'objet machine virtuelle, le resourceKinds est :
Machine virtuelle.

VMware, Inc. 15
Machine Translated by Google

Guide de programmation API

Générer une liste de toutes les métriques de l'objet

Pour générer une liste complète des métriques pour toute machine virtuelle définie dans le modèle d'adaptateur vCenter, vous
effectuez une requête GET à l'URL avec le type d'adaptateur et le type d'objet.

Prérequis

Vérifiez que les exigences suivantes sont respectées :

Vous êtes connecté à l'instance vRealize Operations Manager.

Vous connaissez la valeur adapterKind pour l'adaptateur vCenter et la valeur resourceKinds pour le
machine virtuelle. Consultez la section Déterminer le type d'adaptateur et les types d'objets pour l'adaptateur vCenter.

Procédure

1. Effectuez une requête GET pour obtenir les métadonnées des métriques.

GET [Link]
clés statistiques

2. Comparez les indicateurs listés dans la réponse aux indicateurs affichés dans l'interface utilisateur. Voir
Métriques de la machine virtuelle issues de l'API et de l'interface utilisateur

Exemple : Métriques de machine virtuelle issues de l’API et de l’interface utilisateur

Interface

Cet exemple montre comment les indicateurs de la machine virtuelle listés dans la réponse XML se comparent aux indicateurs
affichés dans l'interface utilisateur de vRealize Operations Manager.

Demande:

GET [Link]
clés de statistiques

Type de contenu : application/json

Autorisation : vRealizeOpsToken <Accept : jeton vROps >
application/json

Où:

n VMWARE est la clé de type d'adaptateur.

n VirtualMachine est la clé resourceKindKey.

n vROps_token est le jeton que vous avez obtenu à partir de la réponse dans Acquérir une authentification
Jeton.

VMware, Inc. 16
Machine Translated by Google

Guide de programmation API

Extrait de la réponse au format JSON :

200 OK

{
"attributs de type de ressource" : [
...
{
"key": "mem|host_workload", "name":
"Mémoire|Charge de travail de l'hôte",
"description": "Charge de travail de l'hôte (%)",
"defaultMonitored": false,
"rollupType": "AVG",
"instanceType": "INSTANCED", "unit":
"%", "dataType2":
"FLOAT", "monitoring": false,
"propriété": false

},
...
]
}

Chaque attribut resourceTypeAttribute de la réponse est une métrique contenant des métadonnées pour un objet de machine virtuelle.

Son nom correspond au texte affiché dans l'interface utilisateur de vRealize Operations Manager.

Dans cet exemple, l'extrait de code liste les métriques relatives à la mémoire et à la charge de travail de l'hôte.

Pour comparer les métriques de la réponse avec celles de l'interface utilisateur, connectez­vous à l'instance vRealize Operations Manager

exécutée sur [Link] et accédez aux métriques d'une machine virtuelle. L'exemple suivant montre où trouver les métriques de

mémoire (hôte) et
Charge de travail.

Cet exemple montre comment récupérer les métriques pour le type d'objet « machine virtuelle ». Pour récupérer les métriques d'autres

types d'objets, remplacez VirtualMachine par le type d'objet correspondant dans la requête GET.

types de ressources.

VMware, Inc. 17
Machine Translated by Google

4
Configuration d'une instance d'adaptateur

Après avoir installé une solution incluant un pack d'administration avec un adaptateur, vous devez configurer une instance
d'adaptateur pour collecter les données des objets définis dans le modèle d'adaptateur. Vous pouvez utiliser l'API vRealize Operations
Manager pour configurer cette instance.

Cet exemple de cas d'utilisation montre comment configurer une instance d'adaptateur pour une solution vSphere et
comprend :

un résumé des opérations avec requête, corps de la requête et réponse pour chaque

une procédure spécifique pour chaque opération

Ce chapitre aborde les sujets suivants :

Résumé de la configuration d'une instance d'adaptateur

n Identifier la solution et ses adaptateurs

Identifiez les types d'objets requis pour l'adaptateur.

n Créer l'instance de l'adaptateur

n Fournir une preuve de validité du certificat

n Démarrer la surveillance de la nouvelle instance d'adaptateur

Résumé des requêtes de configuration d'une instance d'adaptateur

Vous effectuez des requêtes API séquentielles pour configurer une instance d'adaptateur. Les réponses aux requêtes
précédentes fournissent les informations nécessaires aux requêtes suivantes.

Tableau 4­1. Résumé des demandes

Opération Demande Corps de la requête Réponse

Obtenez toutes les solutions GET <API­URL>/suite­ Aucun adapterkindkeys

enregistrées avec le produit api/api/solutions

et identifiez les types d'adaptateurs.

Obtenez tous les types d'objets pour GET <API­URL>/suite­ Aucun types d'identificateurs de ressources

un type d'adaptateur particulier. api/api/adapterkinds/{clé}/

types de ressources

VMware, Inc. 18
Machine Translated by Google

Guide de programmation API

Tableau 4­1. Résumé des demandes (suite)

Opération Demande Corps de la requête Réponse

Créer un objet d'instance d'adaptateur POST <API­URL>/suite­ api/ Valeurs pour adaptateur
api/adapters identifiants de ressources et

titre

Modifiez une instance d'adaptateur PATCH <API­URL>/suite­ api/ Réponse de l'API Réponse de l'API
pour qu'elle reconnaisse le api/adapters POST <API­URL>/suite­ api/ POST <API­URL>/suite­ api/

certificat présenté. api/adapters api/adapters sans certificats

d'adaptateur

Démarrez la surveillance de l'adaptateur METTRE Aucun 200 OK

<API­URL>/suite­api/api/
adaptateurs/{adapterid}/
monitoringstate/start

Identifier la solution et ses adaptateurs

Votre instance vRealize Operations Manager peut comporter plusieurs solutions installées. Pour trouver la solution vSphere
et ses types d'adaptateurs, effectuez une requête GET afin d'obtenir la liste de toutes les solutions.
La réponse inclut tous les adaptateurs fournis avec la solution.

Dans cet exemple d'utilisation, l' URL de l'API pour l'instance vRealize Operations Manager est [Link].

Prérequis

Vérifiez que vous pouvez vous connecter à l'URL de l'API d'une instance vRealize Operations Manager. Consultez la
section « Obtenir un jeton d'authentification ».

Procédure

1. Effectuez une requête GET pour lister toutes les solutions.

GET [Link]

2 Examinez la réponse pour trouver la solution vSphere et ses types d'adaptateurs.

Consultez la section relative aux réponses dans la documentation sur les types d'adaptateurs pour la solution vSphere.

Exemple : Types d’adaptateurs pour la solution vSphere

Cet exemple répertorie toutes les solutions installées et les types d'adaptateurs pour chacune d'elles.

En­tête de la requête :

GET [Link]

VMware, Inc. 19
Machine Translated by Google

Guide de programmation API

La réponse au format JSON :

200 OK

{
"solution":
{
"id": "MPforLogInsight", "name":
"VMware vRealize Operations Management Pack for Log Insight", "version": "6.0.3171089",
"description": "VMware vRealize
Operations Management Pack for Log Insight... ", "vendor": "VMware Inc.", "adapterKindKeys": [

« LogInsightAdapter »
]
},
{
"id": "ep­ops­os­and­availability", "name":
"Systèmes d'exploitation / Surveillance des services à distance", "version":
"1.0.4071095", "description":
"Solution de gestion des opérations des terminaux pour les systèmes d'exploitation...", "vendor": "VMware Inc.",
"adapterKindKeys": [ "ep­ops­os­
and­availability­kind"

]
},
{
"id": "VMware vSphere", "name":
"VMware vSphere", "version":
"6.0.7496664", "description": "Gère
les objets vSphere tels que les clusters, les hôtes...", "vendor": "VMware Inc.", "adapterKindKeys":
[

"VMware",
"Adaptateur Vcenter de remédiation Python"
]
}
]
}

La réponse indique que trois solutions sont installées :

Pack de gestion pour la solution Log Insight

solution d'opérations de point de terminaison

solution n vSphere

La solution vSphere comporte deux types d'adaptateurs :

n VMWARE

n PythonRemediationVcenterAdapter

Pour l'adaptateur vCenter, le type d'adaptateur est VMWARE.

VMware, Inc. 20
Machine Translated by Google

Guide de programmation API

Identifiez les types d'objets requis pour l'adaptateur

Une fois que vous avez déterminé que vous souhaitez créer une instance de l'adaptateur vCenter, vous devez identifier les types

d'objets requis pour cet adaptateur. Vous effectuez une requête GET pour récupérer la liste de tous les types d'objets nécessaires à

l'adaptateur vCenter.

Prérequis

Vérifiez que vous connaissez le type d'adaptateur pour l'adaptateur vCenter.

Procédure

1. Effectuez une requête GET pour lister tous les types d'objets pour l'adaptateur vCenter.

GET [Link]

2. Examinez la réponse pour identifier les types d'objets requis.

Consultez la section relative aux réponses dans la rubrique « Types d'objets requis pour l'adaptateur vCenter ».

Exemple : Types d’objets requis pour l’adaptateur vCenter

Cet exemple trouve tous les types d'objets pour l'adaptateur vCenter.

En­tête de la requête :

GET [Link]

Extrait de la réponse au format JSON :

200 OK

{
"clé": "Instance VMwareAdapter", "nom":
"Serveur vCenter", "type
d'adaptateur": "VMWARE", "type
de type de ressource": "INSTANCE_ADAPTER",
"sous­type de type de ressource":
"AUCUN", "types d'identificateurs de ressource": [
{
"nom" : "AUTODISCOVERY",
"dataType" : "STRING",
"isPartOfUniqueness" : false
},
{
"nom" : "DÉSACTIVER_COMPUTATION_BASED_ON_CONSUMERS",

"type_de_données" : "CHAÎNE",
"estPartie_Uniqueness" : faux
},
{
"nom" : "DV_PORT_GROUP_DISABLED",

"type_de_données" : "CHAÎNE",
"estPartieDeL'Unicité" : faux
},

VMware, Inc. 21
Machine Translated by Google

Guide de programmation API

{
"nom" : "DVS_DISABLED",

"type_de_données" : "CHAÎNE",
"estPartieDeL'Unicité" : faux
},
{
"nom" : "PROCESSCHANGEEVENTS",
"type_de_données" :
"STRING", "isPartOfUniqueness" : false
},
{
"nom" : "VCURL",
"type de données" :
"STRING", "estPartOfUniqueness" : vrai
},
...
{
"nom" : "VM_LIMIT",
"type_de_données" :
"INTEGER", "isPartOfUniqueness" : faux

} ],
...
}

Cet extrait montre le type de ressource avec l'attribut « resourceKindType » : « ADAPTER_INSTANCE ».

Tout type d'objet possédant l'identifiant de ressource « isPartOfUniqueness):true nécessite une valeur pour ce
type d'objet dans la requête API afin de créer l'instance de l'adaptateur.

Une instance d'adaptateur vCenter nécessite une valeur pour VCURL ou l'URL du vCenter.

Créer l'instance d'adaptateur

Après avoir identifié les types d'objets requis pour l'adaptateur, vous fournissez les valeurs des paramètres
correspondants afin de créer une instance d'adaptateur. Votre requête POST inclut un corps de requête contenant
les paramètres requis.

Pour créer une instance d'adaptateur, le paramètre VCURL est obligatoire.

Prérequis

Vérifiez que vous disposez d'une adresse IP et d'identifiants pour vCenter.

Procédure

1. Effectuez une requête POST pour créer l'instance de l'adaptateur.

POST [Link]

2 Examinez la réponse pour trouver le nom de la solution vSphere et ses types d'adaptateurs.

Consultez la section réponse de l'instance d'adaptateur.

VMware, Inc. 22
Machine Translated by Google

Guide de programmation API

Exemple : Instance d’adaptateur

Cet exemple crée l'instance d'adaptateur pour un vCenter avec les paramètres suivants :

Nom d'affichage : Instance de l'adaptateur VC

Description : Instance d’adaptateur vCenter pour VC [Link]

Adresse IP du serveur vCenter : [Link]

n Nom de l'identifiant : VC­Credential­1

n Nom d'utilisateur : administrator@[Link]

n Mot de passe : VC­dummy­passwd

AUTODISCOVERY et PROCESSCHANGEEVENTS sont optionnels, mais sont inclus pour afficher des informations supplémentaires.

Exemples d'identifiants de ressources dans le corps de la requête et dans la réponse.

En­tête de la requête :

POST [Link]

Corps de la requête au format JSON :

{
"nom" : "Instance d'adaptateur VC",
"description" : "Une instance d'adaptateur vCenter pour VC [Link]",
"collectorId" : "1",
"adapterKindKey" : "VMware",
"identifiants de ressources" : [
{
"nom" : "AUTODISCOVERY",
"valeur" : "vrai"

},
{
"nom" : "PROCESSCHANGEEVENTS",
"valeur" : "vrai"

},
{
"nom" : "VCURL",
"valeur" : "[Link]

} ],
"identifiant" : {
"id" : null,
"nom" : "VC­Credential­1",
"adapterKindKey" : "VMware",
"credentialKindKey" : "PRINCIPALCREDENTIAL",
"champs" : [
{
"nom" : "UTILISATEUR",
"valeur" : "administrator@[Link]"
},
{
"nom" : "MOT DE PASSE",

VMware, Inc. 23
Machine Translated by Google

Guide de programmation API

"valeur" : "VC­dummy­passwd"
}

], },
}

Extrait de la réponse au format JSON :

201 Créés

{
"resourceKey": {
"name": "Instance d'adaptateur VC",
"adapterKindKey": "VMWARE",
"resourceKindKey": "Instance d'adaptateur VMware",
"resourceIdentifiers": [
{
"identifierType": { "name":
"AUTODISCOVERY", "dataType":
"STRING",
"isPartOfUniqueness": false
},
"valeur" : "vrai"
},
{
"identifierType": { "name":
"DISABLE_COMPUTATION_BASED_ON_CONSUMERS",
"dataType": "STRING",
"isPartOfUniqueness": false
},
"valeur": ""
},
{
"identifierType": { "name":
"DV_PORT_GROUP_DISABLED", "dataType":
"STRING",
"isPartOfUniqueness": false
},
"valeur": ""
},
{
"identifierType": { "name":
"DVS_DISABLED", "dataType":
"STRING",
"isPartOfUniqueness": false },

"valeur": ""
},
{
"identifierType": { "name":
"PROCESSCHANGEEVENTS",
"dataType": "STRING",
"isPartOfUniqueness": false
},

VMware, Inc. 24
Machine Translated by Google

Guide de programmation API

"valeur" : "vrai"

},
{
"identifierType": { "name":
"VCURL", "dataType":
"STRING", "isPartOfUniqueness":
true
},
"valeur": "[Link]
},
{
"identifierType": { "name":
"VM_FOLDER_DISABLED", "dataType":
"STRING", "isPartOfUniqueness":
false
},
"valeur": ""

},
{
"identifierType" : {
"nom" : "VM_LIMIT",
"type_de_données" :
"STRING", "estPartOfUniqueness" : faux
},
"valeur": ""

] }, "description": "Une instance d'adaptateur vCenter pour VC [Link]", "collectorId": 1,

"collectorGroupId":
"909c2fbf­2c2c­4957­9a75­21bf2a887d31", "credentialInstanceId": "65081a8d­d462­43b2­
b4e0­596eaf3d497e", "monitoringInterval": 5, "adapter­certificates": [

{
"empreinte digitale" : "2520fb4351bc91ee7b82ef7cc54a8d88fa893da9", "détails du
certificat" : "[ Version : V3 Sujet :
C=US, CN=[Link] Algorithme de signature :
SHA256withRSA, OID = 1.2.840.113549.1.1.11 Clé : Clé publique Sun RSA, module 2048 bits : ...

Validité : [Du mercredi 15 juillet 2015 à 19:26:51 UTC, au mardi 8 juillet 2025 à 11:26:30 UTC]
Émetteur : O=W12R2UINanduVC, C=US, DC=local, DC=vsphere, CN=CA ...
...

]"

} ],
...
"identifiant": "a97bd204­e3e5­404b­a219­e2b20cf158d2"
}

L'API crée un nouvel adaptateur doté d'un UUID généré en interne qui identifie l'objet de manière unique.
La réponse de l'API inclut les certificats présentés par vCenter [Link]. L'identifiant de l'instance de
l'adaptateur est utilisé pour démarrer la surveillance et la collecte des données.

VMware, Inc. 25
Machine Translated by Google

Guide de programmation API

Fournir une preuve de validité du certificat

Avant que vRealize Operations Manager puisse se connecter à vCenter et commencer la collecte de données, il
doit vérifier que les sources de données détectées par l'instance d'adaptateur présentent des certificats valides.
Votre requête PATCH apporte la preuve de la validité des certificats en incluant dans son corps la réponse à la requête
POST utilisée pour créer l'adaptateur.

Prérequis

Vérifiez que vous avez bien reçu la réponse à la requête POST utilisée pour créer l'adaptateur. Consultez cette
réponse dans l'instance de l'adaptateur.

Procédure

Effectuez une requête PATCH pour informer le système que l'utilisateur a accepté le certificat.
présenté par vCenter.

PATCH [Link]

Exemple : Validation de certificat

Dans cet exemple, le corps de la requête PATCH est identique à la réponse de la requête POST utilisée pour créer
l'instance de l'adaptateur.

En­tête de la requête :

PATCH [Link]

Corps de la requête au format JSON :

{
"resourceKey": {
"name": "Instance d'adaptateur VC",
"adapterKindKey": "VMware",
"resourceKindKey": "Instance d'adaptateur VMware",
"identifiants de ressources" : [
{
"identifierType": { "name":
"AUTODISCOVERY", "dataType":
"STRING",
"isPartOfUniqueness": false
},
"valeur" : "vrai"
},
{
"identifierType": { "name":
"DISABLE_COMPUTATION_BASED_ON_CONSUMERS",
"dataType": "STRING",
"isPartOfUniqueness": false
},
"valeur": ""
},
{

VMware, Inc. 26
Machine Translated by Google

Guide de programmation API

"identifierType": { "name":
"DV_PORT_GROUP_DISABLED", "dataType":
"STRING",
"isPartOfUniqueness": false
},
"valeur": ""
},
{
"identifierType": { "name":
"DVS_DISABLED", "dataType":
"STRING",
"isPartOfUniqueness": false },

"valeur": ""
},
{
"identifierType": { "name":
"PROCESSCHANGEEVENTS",
"dataType": "STRING",
"isPartOfUniqueness": false
},
"valeur" : "vrai"
},
{
"identifierType": { "name":
"VCURL", "dataType":
"STRING",
"isPartOfUniqueness": true
},
"valeur": "[Link]
},
{
"identifierType": { "name":
"VM_FOLDER_DISABLED", "dataType":
"STRING",
"isPartOfUniqueness": false
},
"valeur": ""
},
{
"identifierType" : {
"nom" : "VM_LIMIT",
"type_de_données" :
"STRING", "estPartOfUniqueness" : faux
},
"valeur": ""
}

] }, "description": "Une instance d'adaptateur vCenter pour VC [Link]", "collectorId":

1, "collectorGroupId":
"909c2fbf­2c2c­4957­9a75­21bf2a887d31", "credentialInstanceId": "65081a8d­
d462­43b2­b4e0­596eaf3d497e", "monitoringInterval": 5, "adapter­certificates": [

VMware, Inc. 27
Machine Translated by Google

Guide de programmation API

{
"empreinte digitale" : "2520fb4351bc91ee7b82ef7cc54a8d88fa893da9", "détails du
certificat" : "[ Version : V3 Sujet :
C=US, CN=[Link] Algorithme de signature :
SHA256withRSA, OID = 1.2.840.113549.1.1.11 Clé : Clé publique Sun RSA, module 2048 bits : ...

Validité : [Du mercredi 15 juillet 2015 à 19:26:51 UTC, au mardi 8 juillet 2025 à 11:26:30 UTC]
Émetteur : O=W12R2UINanduVC, C=US, DC=local, DC=vsphere, CN=CA ...
...

]"

} ],
...
"identifiant": "a97bd204­e3e5­404b­a219­e2b20cf158d2"
}

Réponse au format JSON :

{
"resourceKey": {
"name": "Instance d'adaptateur VC",
"adapterKindKey": "VMWARE",
"resourceKindKey": "Instance d'adaptateur VMware",
"resourceIdentifiers": [
{
"identifierType": { "name":
"AUTODISCOVERY", "dataType":
"STRING", "isPartOfUniqueness":
false
},
"valeur" : "vrai"

},
{
"identifierType": { "name":
"DISABLE_COMPUTATION_BASED_ON_CONSUMERS", "dataType":
"STRING", "isPartOfUniqueness":
false
},
"valeur": ""

},
{
"identifierType": { "name":
"DV_PORT_GROUP_DISABLED", "dataType":
"STRING", "isPartOfUniqueness":
false
},
"valeur": ""

},
{
"identifierType": { "name":
"DVS_DISABLED", "dataType":
"STRING", "isPartOfUniqueness":
false },

"valeur": ""

VMware, Inc. 28
Machine Translated by Google

Guide de programmation API

},
{
"identifierType": { "name":
"PROCESSCHANGEEVENTS",
"dataType": "STRING",
"isPartOfUniqueness": false
},
"valeur" : "vrai"
},
{
"identifierType": { "name":
"VCURL", "dataType":
"STRING",
"isPartOfUniqueness": true
},
"valeur": "[Link]
},
{
"identifierType": { "name":
"VM_FOLDER_DISABLED", "dataType":
"STRING",
"isPartOfUniqueness": false
},
"valeur": ""
},
{
"identifierType" : {
"nom" : "VM_LIMIT",
"type_de_données" :
"STRING", "estPartOfUniqueness" : faux
},
"valeur": ""
}

] }, "description": "Une instance d'adaptateur vCenter pour VC [Link]", "collectorId":

1, "collectorGroupId":
"909c2fbf­2c2c­4957­9a75­21bf2a887d31", "credentialInstanceId": "65081a8d­
d462­43b2­b4e0­596eaf3d497e", "monitoringInterval": 5,

...
"identifiant": "a97bd204­e3e5­404b­a219­e2b20cf158d2"
}

La réponse est identique au corps de la requête, sans la section adapter­certificates.

Démarrer la surveillance de la nouvelle instance d'adaptateur

Après avoir créé l'instance d'adaptateur et configuré vRealize Operations Manager pour reconnaître
un certificat valide, commencez la surveillance et la collecte des données. Votre requête PUT fournit l'UUID
de l'instance d'adaptateur utilisée pour découvrir les nouveaux objets.

VMware, Inc. 29
Machine Translated by Google

Guide de programmation API

Prérequis

Vérifiez que vous disposez bien de l'UUID de l'instance d'adaptateur nouvellement créée. Consultez la réponse dans la section
« Instance d'adaptateur ».

Procédure

Effectuez une requête PUT pour démarrer la surveillance avec la nouvelle instance d'adaptateur.

PUT [Link] adaptateur_UUID>/monitoringstate/start

Exemple : Découvrir des objets et collecter des données

Cet exemple lance le processus de surveillance de l'adaptateur en utilisant l'ID d'instance de l'adaptateur provenant de la requête PUT.
requête qui a créé l'instance d'adaptateur.

En­tête de la requête :

PUT [Link]
monitoringstate/start

VMware, Inc. 30