Cette section répertorie les options spécifiques que vous pouvez utiliser avec l'utilitaire SoS.

Pour plus d'informations sur la collecte de fichiers journaux à l'aide de l'utilitaire SoS, reportez-vous à la section Collecter les journaux pour votre système VMware Cloud Foundation.

Options d'aide de l'utilitaire SoS

Utilisez ces options pour afficher des informations sur l'utilitaire SoS. Pour ces options, connectez-vous via SSH à la machine virtuelle de SDDC Manager à l'aide du compte d'utilisateur vcf et entrez la commande suivante : 
sudo /opt/vmware/sddc-support/sos --option-name
Entrez le mot de passe vcf lorsque vous y êtes invité.
Option Description

--help

-h

Fournit un résumé des options de l'utilitaire SoS disponibles

--version

-v

Fournit le numéro de version de l'utilitaire SoS.

Options génériques de l'utilitaire SoS

Il s'agit d'options génériques de l'utilitaire SoS. Pour ces options, connectez-vous via SSH à la machine virtuelle de SDDC Manager à l'aide du compte d'utilisateur vcf et entrez la commande suivante : 
sudo /opt/vmware/sddc-support/sos --option-name
Entrez le mot de passe vcf lorsque vous y êtes invité.
Option Description
--history Affiche les 20 dernières opérations SoS effectuées.
--force
Permet l'effectuer des opérations SoS pendant l'exécution des workflows.
Note : Il est recommandé de ne pas utiliser cette option.
--configure-sftp Configure SFTP pour les journaux.
--setup-json SETUPJSON

Fichier setup-json personnalisé pour la collecte de journaux.

L'utilitaire SoS prépare automatiquement l'inventaire en fonction de l'environnement dans lequel il s'exécute. Si vous souhaitez collecter des journaux pour un ensemble prédéfini de composants, créez un fichier setup.json et transférez-le en tant qu'entrée à l'utilitaire SoS. Un exemple de fichier JSON est disponible sur la Dispositif SDDC Manager dans /opt/vmware/sddc-support/setup.sample.json.
--log-folder LOGFOLDER Spécifie le nom du répertoire des journaux.
--log-dir LOGDIR Spécifie le répertoire dans lequel stocker les journaux.
--enable-stats Activez la collecte de statistiques d'exécution de l'utilitaire SoS.
--debug-mode Exécute l'utilitaire SoS en mode de débogage.
--zip Crée un fichier .tar compressé pour la sortie.
--short Affichez les résultats de santé détaillés uniquement pour les pannes et les avertissements.
--domain-name DOMAINNAME

Spécifiez le nom du domaine de charge de travail sur lequel effectuer l'opération SoS.

Pour exécuter l'opération sur tous les domaines de charge de travail, spécifiez --domain-name ALL.

Note :

Si vous omettez l'indicateur --domain-name et le nom de domaine de charge de travail, l'opération de l'utilitaire SoS est effectuée uniquement sur le domaine de gestion.

Vous pouvez combiner --domain-name avec --clusternames pour limiter davantage la portée d'une opération. Cela peut être utile dans un environnement mis à l'échelle comportant un grand nombre d'hôtes ESXi.
--clusternames CLUSTERNAMES

Spécifiez les noms de cluster vSphere associés à un domaine de charge de travail pour lequel vous souhaitez collecter les journaux d'ESXi et de la gestion de la charge de travail (WCP, Workload Management).

Entrez une liste séparée par des virgules de clusters vSphere. Par exemple, --clusternames cluster1, cluster2.

Note :

Si vous spécifiez --domain-name ALL, l'option --clusternames est ignorée.

--skip-known-host-check Ignore la vérification spécifiée de l'empreinte numérique SSL de l'hôte connu.
--include-free-hosts Collectez des journaux pour les hôtes ESXi libres en plus des hôtes ESXi en cours d'exécution.
--include-precheck-report Cette option exécute des vérifications préalables à la mise à niveau LCM et inclut le rapport d'exécution des vérifications préalables à la mise à niveau LCM dans les opérations de contrôle de santé de l'utilitaire SoS.

Options de résumé de l'utilitaire SoS de VMware Cloud Foundation

Ces options fournissent des détails récapitulatifs sur l'instance de SDDC Manager, notamment les composants, les services et les tâches. Pour ces options, connectez-vous via SSH à la machine virtuelle de SDDC Manager à l'aide du compte d'utilisateur vcf et entrez la commande suivante : 
sudo /opt/vmware/sddc-support/sos --option-name
Entrez le mot de passe vcf lorsque vous y êtes invité.
Option Description
--get-vcf-summary Renvoie des informations sur votre système VMware Cloud Foundation, notamment le CEIP, les domaines de charge de travail, les clusters vSphere, les hôtes ESXi, les licences, les pools de réseaux, SDDC Manager et les services VCF.
--get-vcf-tasks-summary Renvoie des informations sur les tâches VMware Cloud Foundation, notamment l'heure de création et l'état de la tâche.
--get-vcf-services-summary Renvoie des informations sur le temps d'activité de SDDC Manager et l'heure de démarrage et d'arrêt des services VMware Cloud Foundation (par exemple, LCM).

Options de correction de l'utilitaire SoS

Utilisez ces options pour gérer les hôtes ESXi et les instances de vCenter Server, notamment l'activation de SSH et le verrouillage des hôtes. Pour ces options, connectez-vous via SSH à la machine virtuelle de SDDC Manager à l'aide du compte d'utilisateur administratif vcf, entrez su pour basculer sur l'utilisateur racine, accédez au répertoire /opt/vmware/sddc-support, puis entrez la commande suivante : 
./sos --option-name
Note :

Pour les options de correction, si vous ne spécifiez pas de domaine de charge de travail, la commande affecte uniquement le domaine de gestion.

Option Description

--enable-ssh-esxi

Applique SSH à tous les nœuds ESXi dans les domaines de charge de travail spécifiés.

  • Pour activer SSH sur les nœuds ESXi d'un domaine de charge de travail spécifique, incluez l'indicateur --domain-name DOMAINNAME.
  • Pour activer SSH sur les nœuds ESXi dans tous les domaines de charge de travail, incluez l'indicateur --domain-name ALL.

--disable-ssh-esxi

Désactive SSH sur tous les nœuds ESXi dans les domaines de charge de travail spécifiés.

  • Pour désactiver SSH sur les nœuds ESXi d'un domaine de charge de travail spécifique, incluez l'indicateur --domain-name DOMAINNAME.
  • Pour désactiver SSH sur les nœuds ESXi dans tous les domaines de charge de travail, incluez l'indicateur --domain-name ALL.

--enable-ssh-vc

Applique SSH sur vCenter Server dans les domaines de charge de travail spécifiés.

  • Pour activer SSH sur vCenter dans un domaine de charge de travail spécifique, incluez l'indicateur --domain-name DOMAINNAME.
  • Pour activer SSH sur les instances de vCenter Server dans tous les domaines de charge de travail, incluez l'indicateur --domain-name ALL.

--disable-ssh-vc

Désactive SSH sur les instances de vCenter Server dans les domaines de charge de travail spécifiés.

  • Pour désactiver SSH sur une instance de vCenter Server dans un domaine de charge de travail spécifique, incluez l'indicateur --domain-name DOMAINNAME.
  • Pour désactiver SSH sur les instances de vCenter Server dans tous les domaines de charge de travail, incluez l'indicateur --domain-name ALL.

--enable-lockdown-esxi

Applique le mode de verrouillage normal sur tous les nœuds ESXi dans les domaines de charge de travail spécifiés.

  • Pour activer le verrouillage sur les nœuds ESXi d'un domaine de charge de travail spécifique, incluez l'indicateur --domain-name DOMAINNAME.
  • Pour activer le verrouillage sur les nœuds ESXi dans tous les domaines de charge de travail, incluez l'indicateur --domain-name ALL.

--disable-lockdown-esxi

Désactive le mode de verrouillage normal sur les nœuds ESXi dans les domaines de charge de travail spécifiés.

  • Pour désactiver le verrouillage sur les nœuds ESXi d'un domaine de charge de travail spécifique, incluez l'indicateur --domain-name DOMAINNAME.
  • Pour désactiver le verrouillage sur les nœuds ESXi dans tous les domaines de charge de travail, incluez l'indicateur --domain-name ALL.
--ondemand-service ONDEMANDSERVICE Exécutez des commandes sur les hôtes ESXi, les instances de vCenter Server. ou sur les entités de SDDC Manager pour un domaine de charge de travail donné. Spécifiez le domaine de charge de travail à l'aide de l'indicateur --domain-name DOMAINNAME.

Remplacez ONDEMANDSERVICE par le chemin d'accès à un fichier d'entrée .yml. (Exemple de fichier disponible sous /opt/vmware/sddc-support/ondemand_command_sample.yml).

Avertissement : Contactez le support VMware avant d'utiliser cette option.
--ondemand-service Chemin d'accès au fichier JSON Incluez cet indicateur pour exécuter des commandes au format JSON sur tous les hôtes ESXi dans un domaine de charge de travail. Par exemple, /opt/vmware/sddc-support/<JSON file name>
--refresh-ssh-keys Actualise les clés SSH.

Options du contrôle de santé de l'utilitaire SoS

Ces commandes SoS sont utilisées pour vérifier l'état de santé de divers composants ou services notamment la connectivité, le calcul, le stockage, les domaines de charge de travail et les réseaux. Pour ces options, connectez-vous via SSH à la machine virtuelle de SDDC Manager à l'aide du compte d'utilisateur vcf et entrez la commande suivante : 
sudo /opt/vmware/sddc-support/sos --option-name
Entrez le mot de passe vcf lorsque vous y êtes invité.

Un état vert indique que la santé est normale, un état jaune fournit un avertissement indiquant qu'une attention est requise et un état rouge (critique) indique que le composant a besoin d'une attention immédiate.

Option Description
--health-check

Effectue tous les contrôles de santé disponibles.

Peut être combinée avec --run-vsan-checks. Par exemple : 
sudo /opt/vmware/sddc-support/sos --health-check --run-vsan-checks
--connectivity-health

Effectue des vérifications et des validations de connectivité pour les ressources de SDDC (instances de NSX Manager, hôtes ESXi, instances de vCenter Server, etc.). Ce contrôle effectue une vérification de l'état ping, une vérification de l'état de connectivité SSH et une vérification de la connectivité de l'API pour les ressources de SDDC.
--services-health

Effectue un contrôle de santé des services pour confirmer si les services de SDDC Manager (par exemple, le serveur de gestion de cycle de vie) et de l'instance de vCenter Server sont en cours d'exécution.

--compute-health

Effectue un contrôle de santé de calcul, notamment des licences d'hôte ESXi, du stockage sur disque, des partitions de disque et de l'état de santé.

--storage-health

Effectue une vérification de la santé du disque vSAN des hôtes ESXi et des clusters vSphere.

Peut être combinée avec --run-vsan-checks. Par exemple : 
sudo /opt/vmware/sddc-support/sos --storage-health --run-vsan-checks
--run-vsan-checks Cette option ne peut pas être exécutée seule et doit être combinée avec --health-check ou --storage-health.

Exécutez le test de création de la machine virtuelle pour vérifier la santé du cluster vSAN. L'utilisateur du test crée une machine virtuelle sur chaque hôte du cluster vSAN. Le test crée une machine virtuelle et la supprime. Si les tâches de création et de suppression de machine virtuelle réussissent, partez du principe que les composants du cluster vSAN fonctionnent comme prévu et que le cluster est fonctionnel.

Note : Vous ne devez pas effectuer de test proactif dans un environnement de production, car cela crée du trafic réseau et affecte la charge de travail de vSAN.
--ntp-health

Vérifie si l'heure sur les composants est synchronisée avec le serveur NTP dans la Dispositif SDDC Manager. Elle garantit également que l'horodatage matériel et logiciel des hôtes ESXi se situe dans les 5 minutes de celui de la Dispositif SDDC Manager.

--dns-health Effectue un contrôle de santé DNS direct et inverse.
--general-health

Vérifie les vidages de mémoire d'ESXi et obtient l'état de NSX Manager et du cluster.

--certificate-health

Vérifie que les certificats des composants sont valides et leur date d'expiration.

  • VERT : le certificat expire dans plus de 30 jours.
  • JAUNE : le certificat expire dans 15 à 30 jours.
  • ROUGE : le certificat expire dans moins de 15 jours.
--composability-infra-health

Effectue un contrôle de santé de la connectivité de l'API pour l'infrastructure composable. Si aucune infrastructure composable n'existe, cet indicateur est ignoré. Si une telle infrastructure est trouvée, l'utilitaire vérifie l'état de la connectivité via l'API d'infrastructure composable, telle que Redfish.

--get-host-ips

Renvoie les noms d'hôte et les adresses IP des hôtes ESXi.

--get-inventory-info

Renvoie les détails de l'inventaire des composants VMware Cloud Foundation, tels que vCenter Server NSX, SDDC Manager et les hôtes ESXi. Vous pouvez éventuellement ajouter l'indicateur --domain-name ALL pour renvoyer les détails de tous les domaines de charge de travail.

--password-health
Vérifie l'état des mots de passe sur les composants de VMware Cloud Foundation. Elle répertorie les composants avec des mots de passe gérés par VCF, la date du dernier changement des mots de passe, la date d'expiration des mots de passe et le nombre de jours avant l'expiration.
  • VERT : le mot de passe expire dans plus de 15 jours.
  • JAUNE : le mot de passe expire dans 5 à 15 jours.
  • ROUGE : le mot de passe expire dans moins de 5 jours.
--hardware-compatibility-report Valide les hôtes ESXi et les périphériques vSAN, et exporte le rapport de compatibilité.
--version-health Cette opération vérifie la version des composants de nomenclature (vCenter Server, NSX, ESXi et SDDC Manager). Elle compare l'inventaire de SDDC Manager, la version réelle du composant de nomenclature et les versions du composant de nomenclature pour détecter toute dérive.
--json-output-dir JSONDIR Génère les résultats des contrôles de santé sous la forme d'un fichier JSON dans le répertoire spécifié, JSONDIR.

Exemples de commandes de contrôle de santé :

  • Vérifiez la santé du mot de passe sur le domaine de gestion uniquement :
    ./sos --password-health
  • Vérifiez la santé de la connectivité pour tous les domaines de charge de travail :
    ./sos --connectivity-health --domain-name ALL
  • Vérifiez la santé DNS du domaine de charge de travail nommé sfo-w01 :
    ./sos --dns-health --domain-name sfo-w01