Introduction
Ce document décrit les demandes d'API qui peuvent être utiles lors de conflits d'accès lorsque certaines actions sur les serveurs ne peuvent pas être effectuées via l'interface utilisateur.
Contribution de Luis Uribe Rojas, ingénieur du centre d'assistance technique de Cisco et Justin Pierce, responsable technique.
Conditions préalables
Exigences
Cisco vous recommande de prendre connaissance des rubriques suivantes :
- Intersight
- Serveurs UCS (Unified Computing System)
- Mode géré Intersight (IMM)
- API (Application Programming Interface)
Composants utilisés
Les informations contenues dans ce document sont basées sur les versions de matériel et de logiciel suivantes :
- Interconnexion de fabric Cisco UCS 6454, microprogramme 4.2(1m)
- Serveur lame UCSB-B200-M5, microprogramme 4.2(1a)
- Logiciel Intersight en tant que service (SaaS)
The information in this document was created from the devices in a specific lab environment. All of the devices used in this document started with a cleared (default) configuration. Si votre réseau est en ligne, assurez-vous de bien comprendre l’incidence possible des commandes.
Informations générales
Cisco Intersight fournit une API RESTful basée sur le cloud pour gérer les cibles connectées à Intersight dans plusieurs data centers. Les services d'infrastructure Cisco Intersight incluent le déploiement, la surveillance, la gestion et la prise en charge des infrastructures physiques et virtuelles.
Dans les cas où certaines actions sur les serveurs gérés Intersight ne peuvent pas être effectuées via l'interface utilisateur d'Intersight, soit parce que les options sont grisées, soit parce que l'accès à l'interface utilisateur n'est pas disponible, les requêtes API peuvent être une alternative utile.
Requêtes API du compte Intersight SaaS ou Intersight Appliance
Etapes de présentation
Les exemples suivants suivent une structure cohérente, bien que les paramètres et valeurs spécifiques utilisés puissent varier. Voici un bref résumé des étapes à suivre :
Connectez-vous au compte Intersight.
Dans un environnement SaaS, dans un navigateur, accédez à API Reference et connectez-vous avec votre compte.
Remarque : pour un environnement d'appliance, tel que CVA (Intersight Connected Virtual Appliance) ou PVA (Intersight Private Virtual Appliance) Dans un navigateur, accédez à https://<Appliance-Hostname>/apidocs/apirefs et connectez-vous avec les informations d'identification de l'appliance.
- Recherchez la demande d'API dont vous avez besoin et utilisez un
GET
appel filtré avec des valeurs de champ connues, telles que Numéro de série, Profil de serveur, Nom du serveur, Moid de périphérique, etc.
- Utilisez l'
PATCH
appel avec l'action correspondante pour effectuer la tâche requise
Conseil : sur les paramètres d'interrogation, veillez à utiliser les mêmes lettres exactes pour les exemples de clé et de valeur afin d'éviter les erreurs.
Dans le guide de référence de l'API, il est utile de consulter l'onglet pour connaîtreResponse Model
la syntaxe appropriée et toutes les actions prises en charge qui peuvent être utilisées dans la charge utile d'un appel. Par exemple, dans /api/v1/compute/BladeIdentities/,
les AdminAction pris en charge sont None
,Decommission
,Recommission
, Reack
,Remove
, et Replace
. Ce modèle est utilisé tout au long de ce document.
Désactiver/réactiver un serveur
Dans le document Référence de l'API Intersight, recherchez lacompute/BladeIdentities
demande, sélectionnez le premierGET
appel, puis entrez les paramètres d'interrogation requis.
Cet exemple utilise les paramètres suivants :
Key (Clé) |
Valeur |
Utilisation |
$filter |
Eq. série 'FLM2402001A' |
Pour filtrer la sortie vers le serveur avec le numéro de série fourni. |
$select |
Moid |
Pour sélectionner les valeurs à afficher depuis cet objet. La valeur affichée est le Moid du serveur. |
Appliquez l'PATCH
appel avec l'action requise. Cet exemple utilise :
{"AdminAction":"Decommission"}
Conseil : si la redirection est requise, utilisez {"AdminAction":"Recommission"}.
Conseil : des actions similaires peuvent être exécutées pour les serveurs et châssis intégrés en rack dans IMM. Recherchez les appels d'API compute/RackUnitIdentities et equipment/ChassisIdentities.
Annuler l'attribution du profil serveur
Recherchez la demande Server/Profiles et sélectionnez le premier appel GET, puis entrez les paramètres de requête requis.
Cet exemple utilise les paramètres suivants :
Key (Clé) |
Valeur |
Utilisation |
$filter |
Name Eq 'UCSX-Server-boot-SAN' |
Pour filtrer la sortie vers le profil de serveur dont le nom a été entré. |
$select |
Moid,Nom |
Pour sélectionner les valeurs à afficher à partir de cet objet. Dans ce cas |
Appliquez l'appel PATCH avec l'action requise. Cet exemple utilise :
{"Action":"Unassign"}
Supprimer le serveur
Dans le document Intersight API Reference, recherchez la demande compute/BladeIdentities et sélectionnez le premier GET
appel, puis entrez les paramètres d'interrogation requis.
Cet exemple utilise les paramètres suivants :
Key (Clé) |
Valeur |
Utilisation |
$filter |
Eq. série 'FLM2402001A' |
Pour filtrer la sortie vers le serveur uniquement avec le numéro de série fourni. |
$select |
Moid |
Pour sélectionner les valeurs à afficher depuis cet objet. La valeur affichée est le Moid du serveur. |
Appliquez l'appel PATCH avec l'action requise. Cet exemple utilise :
{"AdminAction":"Remove"}
Avertissement : cette demande entraîne la suppression du serveur de l'inventaire. Pour réajouter le serveur à l'inventaire du domaine, une nouvelle détection est requise. Cela peut être déclenché par une réinstallation physique du serveur ou par une tâche de redécouverte du châssis.
Redémarrer IMC d'un serveur
Dans le document Référence de l'API Intersight, recherchez lacompute/ServerSettings
demande, sélectionnez le premierGET
appel, puis entrez les paramètres d'interrogation requis.
Cet exemple utilise les paramètres suivants :
Key (Clé) |
Valeur |
Utilisation |
$filter |
Nom Eq 'FI-6536-1-3' |
Pour filtrer le résultat vers la lame dont le nom a été entré. |
$select |
Moid,Nom |
Pour sélectionner les valeurs à afficher à partir de cet objet. |
Appliquez l'appel PATCH avec l'action requise. Cet exemple utilise :
{"AdminPowerState":"Reboot"}
Avertissement : cette demande entraîne le redémarrage du trafic IMC pour le serveur en question. Un workflow de détection peu profond est attendu après le redémarrage du contrôleur de gestion.
Dépannage des actions via l'Explorateur d'API dans la console du périphérique
La console de périphérique vous permet de surveiller l'état de vos périphériques et l'état de leur connexion à Intersight. Vous pouvez générer des bundles d'assistance technique contenant des informations de diagnostic pour dépanner et analyser les problèmes. En outre, la console du périphérique permet de lancer l'explorateur d'API pour effectuer des opérations basées sur Redfish™ sur les serveurs.
En cas de perte de connectivité entre Intersight ou le matériel, l'explorateur d'API de la console du périphérique peut également être utilisé pour effectuer certaines actions de dépannage de base.
1) Ouvrez la console Périphérique, accédez à l'une des adresses IP Fabric Interconnect, puis sélectionnez l'onglet Inventaire.
2) Accédez au périphérique spécifique qui doit être dépanné, sélectionnez les trois points à droite de celui-ci et sélectionnezLaunch API Explorer
. L'explorateur d'API est lancé uniquement pour ce périphérique, et pas pour les autres.
Redémarrer le contrôleur de gestion CIMC d'un serveur
Lancez l'Explorateur d'API pour le serveur :
Tapez CIMC dans {ManagerID} et appliquez un POST Managers/{ManagerId}/Actions/Manager.Reset et ajoutez le type de réinitialisation.
Cet exemple utilise :
{"ResetType": "ForceRestart"}
Redémarrer un module d'E/S (IOM)
Lancez l'explorateur d'API de l'IOM :
Tapez CMC dans {ManagerID} et appliquez un POST Managers/{ManagerId}/Actions/Manager.Reset et ajoutez le type de réinitialisation. Cet exemple utilise :
{"ResetType": "ForceRestart"}
Pour redémarrer un IOM homologue dans le champ {ManagerID}, entrezPeerCMC
avec le même appel que précédemment.
Informations connexes
Présentation de l'API Intersight
Présentation de Device Console