Notiz

Dieses Plugin ist Teil der ansible.netcommon-Sammlung (Version 1.5.0).

Um es zu installieren, verwenden Sie: ansible-galaxy collection install ansible.netcommon.

Um es in einem Playbook zu verwenden, geben Sie Folgendes an: ansible.netcommon.network_cli.

Neu in Version 1.0.0: von ansible.netcommon

  • Zusammenfassung
  • Parameter

Zusammenfassung

  • Dieses Verbindungs-Plugin stellt eine Verbindung zu Remote-Geräten über SSH bereit und implementiert eine CLI-Shell. Dieses Verbindungs-Plugin wird normalerweise von Netzwerkgeräten zum Senden und Empfangen von CLi-Befehlen an Netzwerkgeräte verwendet.

Parameter

Parameter Auswahlmöglichkeiten/Standardwerte Aufbau Kommentare
werdenboolesch
    Auswahlmöglichkeiten:

  • nein
  • Jawohl
ini-Einträge:

[privilege_escalation]
werden = nein

env:ANSIBLE_BECOME var: ansible_become

Die Option were weist die CLI-Sitzung an, eine Rechteausweitung auf Plattformen zu versuchen, die dies unterstützen. Normalerweise bedeutet dies einen Übergang vom Benutzermodus zu enable Modus in der CLI-Sitzung. Wenn were auf True gesetzt ist und das Remote-Gerät keine Privilegienausweitung unterstützt oder die Privilegien bereits erhöht wurden, wird diese Option stillschweigend ignoriert. Kann über die CLI konfiguriert werden --become oder -b Optionen.
werde_methodeSchnur Standard:
"sudo"
ini-Einträge:

[privilege_escalation]
were_method = sudo

env:ANSIBLE_BECOME_METHOD var: ansible_become_method

Mit dieser Option kann die Methode "beard" für die Handhabung der Rechteausweitung angegeben werden. In der Regel wird der Wert von become_method auf gesetzt enable könnten aber als andere Werte definiert werden.
GastgeberSchnur Standard:
"inventar_hostname"
var: ansible_host Gibt den FQDN oder die IP-Adresse des Remotegeräts an, zu dem die SSH-Verbindung hergestellt werden soll.
host_key_auto_addboolesch
    Auswahlmöglichkeiten:

  • nein
  • Jawohl
ini-Einträge:

[paramiko_connection]
host_key_auto_add = nein

env:ANSIBLE_HOST_KEY_AUTO_ADD

Standardmäßig fordert Ansible den Benutzer auf, bevor SSH-Schlüssel zur bekannten Hosts-Datei hinzugefügt werden. Da dauerhafte Verbindungen wie network_cli in Hintergrundprozessen ausgeführt werden, wird der Benutzer nie dazu aufgefordert. Wenn Sie diese Option aktivieren, werden unbekannte Hostschlüssel automatisch zur bekannten Hosts-Datei hinzugefügt. Stellen Sie sicher, dass Sie die Sicherheitsauswirkungen der Aktivierung dieser Option auf Produktionssystemen vollständig verstehen, da sie eine Sicherheitslücke schaffen könnte.
network_cli_retriesganze Zahl Standard:
3
ini-Einträge:

[persistent_connection]
network_cli_retries = 3

env:ANSIBLE_NETWORK_CLI_RETRIES var: ansible_network_cli_retries

Anzahl der Verbindungsversuche zum Remote-Host. Die Verzögerungszeit zwischen den Rückzügen erhöht sich nach jedem Versuch um eine Potenz von 2 in Sekunden, bis entweder die maximalen Versuche erschöpft sind oder einer der Versuche persistent_command_timeout oder persistent_connect_timeout Timer ausgelöst werden.
network_osSchnur var: ansible_network_os Konfiguriert das Netzwerkbetriebssystem der Geräteplattform. Dieser Wert wird verwendet, um die richtigen Terminal- und Cliconf-Plugins zu laden, um mit dem Remote-Gerät zu kommunizieren.
PasswortSchnur var: ansible_password var: ansible_ssh_pass var: ansible_ssh_password Konfiguriert das Benutzerkennwort, das zur Authentifizierung beim Remote-Gerät verwendet wird, wenn die SSH-Verbindung zum ersten Mal hergestellt wird.
persistent_buffer_read_timeoutschweben Standard:
0,1
ini-Einträge:

[persistent_connection]
buffer_read_timeout = 0,1

env:ANSIBLE_PERSISTENT_BUFFER_READ_TIMEOUT var: ansible_buffer_read_timeout

Konfiguriert in Sekunden die Zeit, die gewartet werden soll, bis die Daten vom Paramiko-Kanal gelesen werden, nachdem die Eingabeaufforderung angepasst wurde. Dieser Timeout-Wert stellt sicher, dass die übereinstimmende Eingabeaufforderung korrekt ist und keine Daten mehr vom Remote-Host empfangen werden müssen.
persistent_command_timeoutganze Zahl Standard:
30
ini-Einträge:

[persistent_connection]
command_timeout = 30

env:ANSIBLE_PERSISTENT_COMMAND_TIMEOUT var: ansible_command_timeout

Konfiguriert in Sekunden die Zeitdauer, die auf die Rückgabe eines Befehls vom Remote-Gerät gewartet werden soll. Wenn dieser Timer überschritten wird, bevor der Befehl zurückkehrt, löst das Verbindungs-Plugin eine Ausnahme aus und wird geschlossen.
persistent_connect_timeoutganze Zahl Standard:
30
ini-Einträge:

[persistent_connection]
connect_timeout = 30

env:ANSIBLE_PERSISTENT_CONNECT_TIMEOUT var: ansible_connect_timeout

Konfiguriert die Wartezeit in Sekunden, wenn versucht wird, eine dauerhafte Verbindung herzustellen. Wenn dieser Wert abläuft, bevor die Verbindung zum Remotegerät abgeschlossen ist, schlägt die Verbindung fehl.
persistent_log_messagesboolesch
    Auswahlmöglichkeiten:

  • nein
  • Jawohl
ini-Einträge:

[persistent_connection]
log_messages = nein

env:ANSIBLE_PERSISTENT_LOG_MESSAGES var: ansible_persistent_log_messages

Dieses Flag aktiviert die Protokollierung des ausgeführten Befehls und der vom Zielgerät empfangenen Antwort in der Ansible-Protokolldatei. Damit diese Option funktioniert, muss die ansible Konfigurationsoption „log_path“ auf einen Dateipfad mit Schreibzugriff gesetzt werden. Machen Sie sich unbedingt mit den Sicherheitsauswirkungen der Aktivierung dieser Option vertraut, da sie eine Sicherheitslücke schaffen könnte, indem vertrauliche Informationen in der Protokolldatei protokolliert werden .
Hafenganze Zahl Standard:
22
ini-Einträge:

[defaults]
remote_port = 22

env:ANSIBLE_REMOTE_PORT var: ansible_port

Gibt den Port auf dem Remote-Gerät an, das beim Herstellen der SSH-Verbindung auf Verbindungen lauscht.
private_key_fileSchnur ini-Einträge:

[defaults]
private_key_file = Keine

env:ANSIBLE_PRIVATE_KEY_FILE var: ansible_private_key_file

Der private SSH-Schlüssel oder die Zertifikatsdatei, die zur Authentifizierung beim Remote-Gerät verwendet wird, wenn die SSH-Verbindung zum ersten Mal hergestellt wird.
remote_userSchnur ini-Einträge:

[defaults]
remote_user = Keine

env:ANSIBLE_REMOTE_USER var: ansible_user

Der Benutzername, der verwendet wird, um sich beim Remote-Gerät zu authentifizieren, wenn die SSH-Verbindung zum ersten Mal hergestellt wird. Wenn remote_user nicht angegeben ist, verwendet die Verbindung den Benutzernamen des angemeldeten Benutzers. Kann von der CLI über konfiguriert werden --user oder -u Optionen.
ssh_typSchnur Standard:
"paramiko"
ini-Einträge:

[persistent_connection]
ssh_type = paramiko

env:ANSIBLE_NETWORK_CLI_SSH_TYPE var: ansible_network_cli_ssh_type

Die Art des Transports, der von verwendet wird network_cli Verbindungs-Plug-in für die Verbindung zum Remote-Host. Gültiger Wert ist entweder paramiko oder libsch
terminal_inital_prompt_newlineboolesch
    Auswahlmöglichkeiten:

  • nein
  • Jawohl
var: ansible_terminal_initial_prompt_newline Dieses boolesche Flag, das, wenn es auf gesetzt ist WAHR sendet einen Zeilenumbruch in der Antwort, wenn einer der Werte in terminal_initial_prompt Ist abgestimmt.
terminal_initial_answeraufführen / Elemente=Zeichenfolge var: ansible_terminal_initial_answer Die Antwort, mit der geantwortet werden soll, wenn die terminal_initial_prompt Ist abgestimmt. Der Wert kann eine einzelne Antwort oder eine Liste von Antworten für mehrere terminal_initial_prompt sein. Falls das Anmeldemenü mehrere Eingabeaufforderungen hat, sollte die Reihenfolge der Eingabeaufforderung und der ausgenommenen Antwort in der gleichen Reihenfolge und der Wert von sein terminal_prompt_checkall sollte eingestellt werden WAHR wenn alle werte drin sind terminal_initial_prompt Es wird erwartet, dass sie angepasst und eingestellt werden FALSCH wenn eine Anmeldeaufforderung abgeglichen werden soll.
terminal_initial_promptaufführen / Elemente=Zeichenfolge var: ansible_terminal_initial_prompt Ein einzelnes Regex-Muster oder eine Folge von Mustern, um die erwartete Eingabeaufforderung zum Zeitpunkt der ersten Anmeldung beim Remote-Host auszuwerten.
terminal_initial_prompt_checkallboolesch
    Auswahlmöglichkeiten:

  • nein
  • Jawohl
var: ansible_terminal_initial_prompt_checkall Standardmäßig ist der Wert auf eingestellt FALSCH und eine der Eingabeaufforderungen, die in erwähnt werden terminal_initial_prompt Option übereinstimmt, wird nicht nach anderen Eingabeaufforderungen gesucht. Wenn eingestellt auf WAHR Es wird nach allen Eingabeaufforderungen suchen, die in erwähnt werden terminal_initial_prompt Option in der angegebenen Reihenfolge und alle Eingabeaufforderungen sollten vom Remote-Host empfangen werden, wenn nicht, führt dies zu einer Zeitüberschreitung.
terminal_stderr_reaufführen / Elemente=Wörterbuch var: ansible_terminal_stderr_re Diese Option stellt das Regex-Muster und optionale Flags bereit, um die Fehlerzeichenfolge aus dem empfangenen Antwortblock abzugleichen. Diese Option akzeptiert pattern und flags Schlüssel. Der Wert von pattern ist ein Python-Regex-Muster, das der Antwort und dem Wert von entspricht flags ist der akzeptierte Wert von Flaggen Argument von neu kompilieren Python-Methode, um beispielsweise zu steuern, wie Regex mit der Antwort abgeglichen wird 'bin.ich'.
terminal_stdout_reaufführen / Elemente=Wörterbuch var: ansible_terminal_stdout_re Ein einzelnes Regex-Muster oder eine Folge von Mustern zusammen mit optionalen Flags, um die Eingabeaufforderung aus dem empfangenen Antwortblock abzugleichen. Diese Option akzeptiert pattern und flags Schlüssel. Der Wert von pattern ist ein Python-Regex-Muster, das der Antwort und dem Wert von entspricht flags ist der akzeptierte Wert von Flaggen Argument von neu kompilieren Python-Methode, um beispielsweise zu steuern, wie Regex mit der Antwort abgeglichen wird 'bin.ich'.

Autoren

  • Ansible Networking-Team