Définir une requête d'API pour les appareils de cloud computing

Dans le cadre de la création ou de la modification d'un modèle de détection, vous pouvez utiliser l'opération Appel REST dans le cloud pour extraire des informations des éléments de configuration du type PaaS (Platform as a Service, plateforme en tant que service), tels que Microsoft Azure ou Amazon Web Services.

Avant de commencer

Rôle requis : pd_admin

• Vérifiez que le système d'exploitation de l'élément de configuration (CI) pour lequel vous souhaitez utiliser l'opération Appel REST dans le cloud étend le type de système d'exploitation du centre de données logique [cmdb_ci_logical_datacenter] :
  1. Accédez à l'onglet De base du modèle de CI.
  2. Notez le système d'exploitation de ce CI.
  3. Accédez à la Définition du système > Tables.
  4. Définissez le champ de recherche sur Étiquette et saisissez le nom du système d'exploitation comme indiqué dans l'onglet De base du modèle.
  5. Cherchez le système d'exploitation dans la liste et vérifiez que le centre de données logique apparaît dans la colonne Étend la table.
• Accédez à l'étape de modèle pertinente :
  1. Sur le formulaire de modèle, sélectionnez la section d'identification pertinente pour Détection.

     Vous pouvez également sélectionner la section d'identification ou de connexion pertinente pour Mappage des services.

  2. Sélectionnez l'étape de modèle pertinente ou cliquez sur le bouton pour ajouter une étape.

Une connaissance de base de la programmation est souhaitée.

Pourquoi et quand exécuter cette tâche

Déployez l'opération Appel REST dans le cloud dans les modèles utilisés pour la détection des CI PaaS.

Consultez la documentation officielle relative à l'API fournie par les fabricants pour obtenir la syntaxe de requête de l'appareil que vous souhaitez interroger à l'aide de l'opération Appel REST dans le cloud. Par exemple :

• http://docs.aws.amazon.com/AWSEC2/latest/APIReference/Welcome.html
• https://docs.microsoft.com/en-us/rest/api/apimanagement/

Procédure

1. Sélectionnez Appel REST dans le cloud dans la liste Opération.
2. Définissez les paramètres de requête si nécessaire :
   Avertissement :

   Si vous avez personnalisé cette opération comme décrit dans Personnaliser les opérations de modèle, les paramètres de requête peuvent être différents.

   Champ	Description
   URL	Spécifiez l'URL comme décrit dans la documentation officielle de Microsoft Azure ou Amazon Web Services. Vous pouvez utiliser des variables. Vous pouvez utiliser des variables. Vous pouvez également saisir une valeur du champ spécifique dans une variable tabulaire, comme décrit dans Saisir des valeurs et des variables dans les modèles.
   Méthode	Saisissez la valeur de la méthode sous forme de chaîne en lettres majuscules, par exemple « GET ». Les méthodes prises en charge sont les suivantes : GET POST PUT Reportez-vous au guide d'API pertinent pour plus d'informations. Si la documentation de l'API ne mentionne pas spécifiquement la méthode de requête HTTP, utilisez la méthode GET.
   Corps	(Facultatif) Entrez un corps de requête sous forme de chaîne. Si la chaîne contient des guillemets, utilisez la barre oblique inverse devant les guillemets pour indiquer que la chaîne ne se termine pas aux guillemets.
   En-têtes	(Facultatif) Si la documentation d'API pertinente indique que des en-têtes HTTP doivent être envoyés, entrez ces en-têtes au format suivant : Header_name1:header_value1,header_name2:header_value2 Par exemple, Content-Type:xml.

3. Pour enregistrer l'intégralité de la sortie de commande en tant que variable, sélectionnez AUCUN dans la liste Définir l'analyse et définissez la variable comme décrit dans 6.
4. Sélectionnez la stratégie d'analyse dans la liste Définir l'analyse.

   Stratégie d'analyse	Description
   Oracle Fichier LDAP Fichier XML Fichier INI Fichier de propriétés Fichier JSON (personnalisé)	Stratégie d'analyse horizontale du fichier (pas verticale). Vous pouvez utiliser cette stratégie d'analyse uniquement pour les fichiers texte. Pour en savoir plus, consultez Analyser du texte à partir d'un fichier horizontal.
   Fichier vertical	Récupérez le texte à partir d'un fichier texte structuré où chaque ensemble de données s'étend sur plusieurs lignes. Pour en savoir plus, consultez Analyser du texte à partir d'un fichier vertical.
   Après le mot clé	Récupérez le texte directement en suivant un mot clé spécifique. Pour en savoir plus, consultez Analyser du texte à l'aide d'un mot clé, d'une commande et d'un type de position.
   Style de ligne de commande Java	Récupérez la valeur d'un paramètre de ligne de commande à l'aide des paramètres de style Java. Pour en savoir plus, consultez Analyser du texte à l'aide d'un mot clé, d'une commande et d'un type de position.
   Style de ligne de commande Unix	Récupérez la valeur d'un paramètre de ligne de commande à l'aide des paramètres Unix standard. Pour en savoir plus, consultez Analyser du texte à l'aide d'un mot clé, d'une commande et d'un type de position.
   Position à partir de la fin	Récupérez le texte spécifié par sa position à partir de la fin de la ligne. Pour en savoir plus, consultez Analyser du texte à l'aide d'un mot clé, d'une commande et d'un type de position.
   Position à partir du début	Récupérez le texte spécifié par sa position à partir du début de la ligne. Pour en savoir plus, consultez Analyser du texte à l'aide d'un mot clé, d'une commande et d'un type de position.
   Expression régulière	Récupérez le texte spécifié par une expression régulière. Cette option nécessite de connaître la syntaxe Regex Java. Pour en savoir plus, consultez Analyser du texte à l'aide d'une expression régulière.
   Texte délimité	Récupérez le texte spécifié par les délimiteurs et la position dans la ligne (la manière la plus courante de récupérer le texte à partir des fichiers texte génériques). Voir Analyser du texte à l'aide d'un texte délimité.

5. Si vous travaillez en mode de débogage, définissez les critères d'analyse comme suit :
   1. Cliquez sur Exécuter une opération pour afficher le résultat dans le volet Sortie.
   2. Dans le panneau Sortie, marquez le texte ou les symboles que vous souhaitez que la variable contienne.
   3. Dans la zone de nom de la variable, saisissez le nom de la nouvelle variable, par exemple « process_name ».
      
      
      
   4. Appuyez sur Entrée.
      La nouvelle variable est ajoutée dans le panneau Variables.
6. Si vous ne travaillez pas en mode de débogage, effectuez les étapes suivantes pour définir les critères d'analyse comme suit.
   1. Dans le panneau Variables, cliquez sur Ajouter une variable, puis saisissez le nom de la nouvelle variable.
   2. Cliquez sur l'icône Avancé.
      
      
      
   3. Cliquez sur Ajouter une étiquette de colonne.
   4. Entrez la requête d'analyse.
   5. Entrez une valeur pour le délimiteur.
   6. Entrez une valeur pour la position.
7. Sélectionnez Terminer pour arrêter la détection si aucun résultat n'est trouvé.
8. Si vous êtes en mode de débogage, testez l'étape en cliquant sur Test et en vérifiant que l'opération renvoie le résultat attendu.

Exemple

Cette opération est utilisée dans	Cet élément
Hiérarchie	Application
Type de CI	Service d'équilibreur de charge [cmdb_ci_lb_service]
Modèle	Amazon AWS Elastic Load Balancer Service
Section	AWS Load Balancer Service
Numéro et nom de l'étape	2. Obtenir les 100 premières instances RDS

Utilisez l'opération Appel REST dans le cloud pour extraire des informations sur les instances de base de données en cours d'exécution sur la région us-west-2 dans le cloud Amazon.

Que faire ensuite

• Continuez à modifier le modèle en ajoutant une nouvelle étape et en définissant son fonctionnement.
• Finalisez le modèle.

Tâches associées

• Activer le mode Déboguer du modèle
• Rendre une étape conditionnelle

Référence associée

• Saisir des valeurs et des variables dans les modèles
• Variables de modèle