Parameter für SSHCommand

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 4 Minuten Lesedauer

    • Für die Probe „SSHCommand“ sind mehrere Parameter verfügbar.

    Anweisungen zum Konfigurieren der Sondenparameter finden Sie unter Probe-Parameter festlegen .

    Tabelle : 1. Parametertabelle
    Parameter Beschreibung
    allow_unsupported_shells Ermöglicht einem Probe-Designer, einen Befehl auf einem Gerät ohne unterstützte Shell auszuführen. Ohne Shell gilt:
    • Es können keine Pfadinformationen angegeben werden.
    • Es können keine Skripts ausgeführt werden, da keine Möglichkeit besteht, Skriptparameter zu verarbeiten.
    • Der im Feld ECC-Warteschlangenname des Probe-Formulars angegebene Text ist der Rohbefehl, der auf dem Gerät ausgeführt wird.

    Beispielsweise können Sie eine Probe entwerfen, um die Version eines Cisco-Switch anzuzeigen, auf dem NX-OS ausgeführt wird. Der Befehl, den der Switch versteht, lautet show version. Um dies zu erreichen, fügen Sie den Befehl show version in das Feld ECC-Warteschlangenname ein und fügen den Parameternamen allow_unsupported_shells mit dem Wert true hinzu.

    Dieser Parameter ist nur für sncssh wirksam. Für j2ssh wird er nicht unterstützt. Die derzeit unterstützten Shells lauten sh, bash, ksh, csh und tcsh.

    • Typ: Zeichenfolge, „true“ oder „false“
    • Standardwert: false
    Quelle [Erforderlich] Gibt den ersten Host an, zu dem eine Verbindung hergestellt werden soll
    • Typ: Zeichenfolge (URL)
    • Standardwert: keiner
    port Gibt den Zielport für die Verbindung an
    • Typ: Ganzzahl (Port)
    • Standardwert: 22
    debug Gibt an, ob SSH-Debug-Informationen in die Protokolldatei geschrieben werden sollen. Die Parameterverwendung hängt davon ab, ob der ServiceNow-SSH-Client aktiviert ist.
    Wenn der SSH-Client von ServiceNow aktiviert ist, funktioniert dieser Parameter wie folgt:
    • Typ: Zeichenfolge
    • Standardwert: false
      Die folgenden Zeichenfolgenwerte sind für den SSH-Client von ServiceNow gültig:
      • true: Aktiviert SSH-Debug-Informationen in der Protokolldatei.
      • false: Deaktiviert SSH-Debug-Informationen in der Protokolldatei.
      • <IP-Adressen>: Gibt an, für welche IP-Bereiche SSH-Debug-Informationen in der Protokolldatei aktiviert werden sollen. Sie können IP-Adressen in den folgenden Formaten eingeben:
        • Ein IP-Bereich, der durch einen Schrägstrich und die Anzahl der Bits im Subnetz definiert ist. Beispielsweise durchsucht der String 10.10.10.0/24 24-Bit-IP-Adressen von 10.10.10.0 bis 10.10.10.254.
        • Ein IP-Bereich, der durch einen Bindestrich definiert wird. Der String 10.10.11.0-10.10.11.165 durchsucht beispielsweise die IP-Adressen von 10.10.11.0 bis 10.10.11.165.
        • Eine durch Kommas getrennte Liste bestimmter IP-Adressen. Zum Beispiel durchsucht der String 10.10.11.200.10.10.11.235 die IP-Adressen 10.10.11.200 und 10.10.11.235.
      • deferred: Gibt an, dass SSH-Debug-Informationen im Speicher protokolliert werden sollen, sofern keine Fehler oder Warnungen auftreten. Wenn ein Fehler oder eine Warnung auftritt, veröffentlicht die Plattform die Debug-Informationen in der Protokolldatei. Dadurch wird sichergestellt, dass nur der Teil der Protokolldatei aufgezeichnet wird, der sich auf den Fehler oder die Warnung bezieht. Wenn kein Fehler oder keine Warnung erkannt wird, löscht die Plattform die nicht verwendeten Protokolldaten aus dem Speicher, sobald die Sitzung geschlossen wird. In jeder Sitzung werden bis zu 1000 Protokollnachrichten gespeichert. Wenn die Sitzung 1000 Protokollnachrichten überschreitet, verwirft das verzögerte Protokoll die älteste Protokollnachricht, um Platz für die neueste Protokollnachricht zu schaffen.
    Wenn der SSH-Client von ServiceNow deaktiviert ist, aktiviert bzw. deaktiviert dieser Parameter SSH-Debug-Informationen in der Protokolldatei:
    • Typ: true | false
    • Standardwert: false
    debug_ssh Gibt an, ob der veraltete SSH-Client Debug-Informationen in die Protokolldatei agent/logs/agent.log schreibt.
    Hinweis:
    Diese Protokolldatei kann schnell größer werden und sollte deaktiviert werden, wenn sie nicht benötigt wird.
    Der ServiceNow-SSH-Client verwendet diesen Parameter nicht.
    • Typ: true | false
    • Standardwert: false
    timeout Legt den Socket-Verbindungstimeout für den veralteten SSH-Client fest.
    Der ServiceNow-SSH-Client verwendet diesen Parameter nicht.
    • Typ: Ganzzahl (Millisekunden)
    • Standardwert: 60.000
    path_override Gibt an, wie die Standardpfade geändert werden können, die vor der Ausführung eines Befehls festgelegt wurden. Geben Sie einen oder mehrere durch Doppelpunkt (:) getrennte Überschreibungspfade ein. Der Standardpfad ist /usr/sbin: /usr/bin:/bin:/sbin.
    Der SSH-Client von ServiceNow akzeptiert die folgenden Präfixe vor dem Wert path_overide.
    • append: Hängt den Überschreibungspfad an das Ende des Hostpfads an. Dies ist das Standardverhalten.
    • replace: Ersetzt den Hostpfad durch den Wert path_overide.
    • prepend: Stellt den Überschreibungspfad dem Hostpfad voran.
    • Typ: Zeichenfolge (eine durch Doppelpunkte getrennte Liste von Verzeichnissen)
    • Standardwert: keiner
    keyboard_interactive Bestimmt, ob der SSH-Anmeldemodus keyboard_interactive erzwungen wird
    • Typ: true | false
    • Standardwert: false
    must_sudo Bestimmt, ob SSH-Befehle über sudo ausgeführt werden
    Hinweis:
    Der Probe-Parameter must_sudo wirkt sich auf alle Muster aus. Auf Unix- oder Linux-Hosts kann die Musterausführung viele verschiedene Befehle ausführen, bei einigen darf sudo nicht angehängt sein.
    • Typ: Wahr | Falsch
    • Standardwert: false
    run_in_terminal Bestimmt, ob SSH-Befehle in einem SSH-Terminal ausgeführt werden
    • Typ: true | false
    • Standardwert:
      • SSH-Client von ServiceNow: false
      • Veralteter SSH-Client: true
    set_path Bestimmt, ob die Probe die PATH-Variable der Sitzung ändern darf. Standardmäßig wird die PATH-Variable während des Sitzungs-Setup auf /usr/sbin:/usr/bin:/bin:/sbin festgelegt.
    • Typ: true | false
    • Standardwert: true
    rm_override Überschreibt den Standardbefehl zum Entfernen (/bin/rm -f) mit dem angegebenen Wert
    • Typ: Zeichenfolge
    • Standardwert: keiner
    use_snc_ssh Aktiviert den SSH-Client von ServiceNow. Der SSH-Client von ServiceNow ist bei neuen Instanzen standardmäßig aktiviert. Durch das Aktivieren des SSH-Clients von ServiceNow wird der veraltete SSH-Client deaktiviert.
    • Typ: true | false
    • Standardwert: true
    command_timeout_ms Anzahl von Millisekunden, die ein SSH-Befehl ausgeführt werden darf, bevor eine Zeitüberschreitung auftritt (Standardeinstellung pro MID Server konfigurierbar).
    Der veraltete SSH-Client verwendet diesen Parameter nicht.
    • Typ: Ganzzahl
    • Standardwert: Wert des MID Server-Parameters mid.ssh.command_timeout_ms
    channel_timeout_ms Gibt den Zeitraum in Millisekunden an, die ein MID Server während der Verarbeitung eines SSH-Befehls auf Aktivität wartet. Wenn der MID Server im angegebenen Zeitüberschreitungsfenster keine Aktivität erkennt, beendet dieser Parameter den Befehl.
    • Typ: Ganzzahl (Millisekunden)
    • Standardwert: 300000 (5 Minuten)
    preserve_sudo_environment Gibt an, ob Sudo verwendet werden soll, um die Umwelt für SSH zu erhalten. Dieser Parameter ist nur wirksam, wenn die sudo-Umgebung auf dem geprüften Host den Schalter -E unterstützt.
    • Typ: true | false
    • Standardwert: false
    credentials_debug

    Zeigt einen <credentials_debug>-Abschnitt in der ECC-Warteschlange an, der Ihnen bei der Behebung von Problemen mit den Anmeldeinformationen helfen kann. Wenn Sie diese Eigenschaft auf „true“ setzen, werden Informationen zur Behandlung von Problemen mit Anmeldeinformationen in der ECC-Warteschlange ausgegeben, auch wenn die Anmeldeinformationen erfolgreich sind. Weitere Informationen finden Sie unter Problembehandlung bei Anmeldeinformationen.