Paramètres SSHCommand

  • Rversion finale: Zurich
  • Mis à jour 31 juil. 2025
  • 5 minutes de lecture
  • Plusieurs paramètres sont disponibles pour la sonde SSHCommand.

    Pour obtenir des instructions sur la configuration des paramètres de sonde, consultez Configurer les paramètres de sonde.

    Tableau 1. Table des paramètres
    Paramètre Description
    allow_unsupported_shells Permet à un concepteur de sonde de tenter d'exécuter une commande sur un appareil qui ne prend en charge aucun shell. Sans shell, la valeur suivante est définie sur vrai :
    • Aucune information sur le chemin d'accès ne peut être fournie.
    • Aucun script ne peut fonctionner, car il est impossible de gérer les paramètres de script.
    • Le texte spécifié dans le champ Nom de la file d'attente ECC du formulaire de sonde est la commande brute exécutée sur l'appareil.

    Par exemple, vous pouvez concevoir une sonde pour afficher la version d'un commutateur Cisco exécutant NX-OS. La commande que le commutateur comprend est show version. Pour ce faire, placez la commande show version dans le champ Nom de la file d'attente ECC, puis ajoutez le nom du paramètre allow_unsupported_shells avec une valeur vrai.

    Ce paramètre ne prend effet que pour sncssh. Il n'est pas pris en charge avec j2ssh. Les shells actuellement pris en charge sont les suivants : sh, bash, ksh, csh et tcsh.

    • Type : chaîne, vrai ou faux
    • Valeur par défaut : faux
    source [Requis] Spécifie l'hôte initial auquel se connecter.
    • Type : chaîne (URL)
    • Valeur par défaut : Aucun
    port Spécifie le port cible auquel se connecter.
    • Type : nombre entier (port)
    • Valeur par défaut : 22
    debug Indique s'il est nécessaire d'écrire des informations de débogage SSH dans le fichier journal. Ce paramètre est utilisé selon que le client SSH ServiceNow est activé ou non.
    Lorsque le client SSH ServiceNow est activé, ce paramètre fonctionne comme suit :
    • Type : chaîne
    • Valeur par défaut : faux
      Les valeurs de chaîne suivantes sont valides pour le client SSH ServiceNow :
      • vrai : active les informations de débogage SSH dans le fichier journal.
      • faux : désactive les informations de débogage SSH dans le fichier journal.
      • <Adresses IP> : spécifie les plages IP permettant d'activer les informations de débogage SSH dans le fichier journal. Vous pouvez saisir les adresses IP aux formats suivants :
        • Une plage d'adresses IP définie par une barre oblique et le nombre de bits dans le sous-réseau. Par exemple, la chaîne 10.10.10.0/24 analyse les adresses IP 24 bits de la plage comprise entre 10.10.10.0 et 10.10.10.254.
        • Une plage d'adresses IP définie par un tiret. Par exemple, la chaîne 10.10.11.0-10.10.11.165 analyse les adresses IP de la plage comprise entre 10.10.11.0 et 10.10.11.165.
        • Une liste d'adresses IP spécifiques, séparée par des virgules. Par exemple, la chaîne 10.10.11.200,10.10.11.235 analyse les adresses IP 10.10.11.200 et 10.10.11.235.
      • différé : spécifie qu'il est nécessaire de consigner les informations de débogage SSH dans la mémoire, à moins qu'une erreur ou un avertissement ne se produise. Si une erreur ou un avertissement se produit, la plateforme publie les informations de débogage dans le fichier journal. Ainsi, seule la partie du fichier journal relative à l'erreur ou à l'avertissement est enregistrée. Si aucune erreur ou aucun avertissement n'est détecté, la plateforme supprime les données de journal inutilisées de la mémoire lorsque la session se ferme. Chaque session stocke jusqu'à 1 000 messages de journal. Si la session dépasse 1 000 messages de journal, le journal différé ignore le message de journal le plus ancien pour faire place au message de journal le plus récent.
    Lorsque le client SSH ServiceNow est désactivé, ce paramètre active ou désactive les informations de débogage SSH dans le fichier journal :
    • Type : vrai | faux
    • Valeur par défaut : faux
    debug_ssh Spécifie si le client SSH hérité écrit des informations de débogage dans le fichier journal agent/logs/agent.log.
    Remarque :
    ce fichier journal peut devenir rapidement volumineux et doit être désactivé si nécessaire.
    Le client SSH ServiceNow n'utilise pas ce paramètre.
    • Type : vrai | faux
    • Valeur par défaut : faux
    timeout Définit le délai d'expiration de connexion de l'embase pour le client SSH hérité.
    Le client SSH ServiceNow n'utilise pas ce paramètre.
    • Type : nombre entier (millisecondes)
    • Valeur par défaut : 60 000
    path_override Spécifie le mode de modification des chemins d'accès par défaut définis avant d'exécuter une commande. Saisissez un ou plusieurs chemins de remplacement délimités par un deux-points (:). Le chemin d'accès par défaut est le suivant : /usr/sbin: /usr/bin: /bin: /sbin.
    Le client SSH ServiceNow accepte les préfixes suivants devant la valeur path_overide :
    • ajouter : ajoute le chemin de remplacement à la fin du chemin d'accès de l'hôte. Il s'agit du comportement par défaut.
    • remplacer : remplace le chemin d'accès de l'hôte par la valeur path_overide.
    • préfixer : ajoute le chemin de remplacement devant le chemin d'accès de l'hôte.
    • Type : chaîne (liste de répertoires séparés par deux points)
    • Valeur par défaut : Aucun
    keyboard_interactive Détermine s'il est nécessaire d'appliquer le mode de connexion SSH keyboard_interactive.
    • Type : vrai | faux
    • Valeur par défaut : faux
    must_sudo Détermine si les commandes SSH s'exécutent via sudo.
    Remarque :
    must_sudo paramètre de sonde affecte tous les modèles. Sur les hôtes Unix ou Linux, l’exécution de modèles peut exécuter de nombreuses commandes différentes, certaines ne devraient pas avoir sudo ajouté.
    • Type : true | false
    • Valeur par défaut : faux
    run_in_terminal Détermine si les commandes SSH s'exécutent dans un terminal SSH.
    • Type : vrai | faux
    • Valeur par défaut :
      • Client SSH ServiceNow : faux
      • Client SSH hérité : vrai
    set_path Détermine si la sonde est autorisée à modifier ou non la variable PATH de la session. Par défaut, pendant la configuration de la session, la variable PATH est définie sur /usr/sbin:/usr/bin:/bin:/sbin.
    • Type : vrai | faux
    • Valeur par défaut : vrai
    rm_override Remplace la commande de suppression par défaut (/bin/rm -f) par la valeur fournie.
    • Type : chaîne
    • Valeur par défaut : aucune
    use_snc_ssh Active le client SSH ServiceNow. Le client SSH ServiceNow est actif par défaut sur les nouvelles instances. L'activation du client SSH ServiceNow désactive le client SSH hérité.
    • Type : vrai | faux
    • Valeur par défaut : vrai
    command_timeout_ms Durée (en millisecondes) pendant laquelle une commande SSH est autorisée à s'exécuter avant d'expirer (il est possible de configurer la valeur par défaut sur chaque MID Server).
    Le client SSH hérité n'utilise pas ce paramètre.
    • Type : nombre entier
    • Valeur par défaut : valeur du paramètre mid.ssh.command_timeout_ms du MID Server.
    channel_timeout_ms Spécifie la durée, en millisecondes, pendant laquelle un MID Server attend l'activité au cours du traitement d'une commande SSH. Si le MID Server ne détecte pas d'activité dans la période d'expiration spécifiée, ce paramètre arrête la commande.
    • Type : nombre entier (millisecondes)
    • Valeur par défaut : 300 000 (5 minutes)
    preserve_sudo_environment Indique s'il est nécessaire d'utiliser sudo pour préserver l'environnement pour SSH. Ce paramètre n'est effectif que si l'environnement sudo sur l'hôte sondé prend en charge le commutateur -E.
    • Type : vrai | faux
    • Valeur par défaut : faux
    credentials_debug

    Affiche une section <credentials_debug> dans la file d'attente ECC, qui peut vous aider à résoudre les problèmes liés aux informations d'identification. Si vous définissez cette propriété sur vrai, les informations de dépannage des informations d'identification sont générées dans la file d'attente ECC, même si les informations d'identification sont correctes. Voir Dépannage des informations d’identification pour plus d’informations.