network_cli – Использование network_cli для выполнения команд на сетевых устройствах
Описание
- Этот плагин подключения обеспечивает подключение к удаленным устройствам через SSH и реализует оболочку командной строки. Этот плагин подключения обычно используется сетевыми устройствами для отправки и получения команд CLI сетевым устройствам.
Параметры
| Параметр | Варианты/Значения по умолчанию | Настройка | Комментарии |
|---|---|---|---|
| become логический | Значение по умолчанию: "нет" | записи ini: [privilege_escalation] переменная среды:ANSIBLE_BECOME переменная: ansible_become | Параметр become укажет сессии CLI на попытку повышения привилегий на платформах, которые ее поддерживают. Обычно это означает переход от пользовательского режима к enable режиму в сессии CLI. Если become установлен в True, а удаленное устройство не поддерживает повышение привилегий или привилегии уже повышены, то этот параметр будет проигнорирован.Можно настроить с помощью командной строки с помощью опций --become или -b. |
| become_method - | Значение по умолчанию: "sudo" | записи ini: [privilege_escalation] переменная среды:ANSIBLE_BECOME_METHOD переменная: ansible_become_method | Этот параметр позволяет указать метод повышения привилегий. Типичное значение become_method - enable, но оно может быть другим. |
| host - | Значение по умолчанию: "inventory_hostname" | переменная: ansible_host | Указывает FQDN или IP-адрес удаленного устройства для установления SSH-соединения. |
| host_key_auto_add логический | Значение по умолчанию: "нет" | записи ini: [paramiko_connection] переменная среды:ANSIBLE_HOST_KEY_AUTO_ADD | По умолчанию Ansible запросит пользователя перед добавлением SSH-ключей в файл известных хостов. Поскольку постоянные подключения, такие как network_cli, выполняются в фоновых процессах, пользователь никогда не будет запрошен. Включив этот параметр, неизвестные ключи хостов будут автоматически добавлены в файл известных хостов. Необходимо понимать последствия включения этого параметра в производственной среде, так как это может создать уязвимость безопасности. |
| network_cli_retries целое число добавлен в 2.9 | Значение по умолчанию: 3 | записи ini: [persistent_connection] переменная среды:ANSIBLE_NETWORK_CLI_RETRIES переменная: ansible_network_cli_retries | Количество попыток подключения к удаленному хосту. Время ожидания между попытками увеличивается после каждой попытки в степени 2 в секундах, пока не будет исчерпано максимальное количество попыток или не будут сработаны таймеры persistent_command_timeout или persistent_connect_timeout. |
| network_os - | переменная: ansible_network_os | Настраивает сетевую операционную систему платформы устройства. Это значение используется для загрузки правильных плагинов терминала и cliconf для связи с удаленным устройством. | |
| password - | переменная: ansible_password переменная: ansible_ssh_pass переменная: ansible_ssh_password | Настраивает пароль пользователя, используемый для аутентификации на удаленном устройстве при первом установлении SSH-соединения. | |
| persistent_buffer_read_timeout вещественное число | Значение по умолчанию: 0.1 | записи ini: [persistent_connection] переменная среды:ANSIBLE_PERSISTENT_BUFFER_READ_TIMEOUT переменная: ansible_buffer_read_timeout | Настраивает время в секундах ожидания данных для чтения из канала Paramiko после сопоставления приглашения командной строки. Эта временная метка гарантирует, что приглашение командной строки соответствует действительности и больше нет данных, ожидаемых от удаленного хоста. |
| persistent_command_timeout целое число | Значение по умолчанию: 30 | записи ini: [persistent_connection] переменная среды:ANSIBLE_PERSISTENT_COMMAND_TIMEOUT переменная: ansible_command_timeout | Настраивает время в секундах ожидания возврата команды с удаленного устройства. Если этот таймер превышен до возврата команды, плагин подключения сгенерирует исключение и закроет соединение. |
| persistent_connect_timeout целое число | Значение по умолчанию: 30 | записи ini: [persistent_connection] переменная среды:ANSIBLE_PERSISTENT_CONNECT_TIMEOUT переменная: ansible_connect_timeout | Настраивает время в секундах ожидания при первой попытке установления постоянного подключения. Если это значение истечет до завершения подключения к удаленному устройству, подключение будет прервано. |
| persistent_log_messages логический | Значение по умолчанию: "нет" | записи ini: [persistent_connection] переменная среды:ANSIBLE_PERSISTENT_LOG_MESSAGES переменная: ansible_persistent_log_messages | Этот флаг включит ведение в журнале команды, выполняемой и получаемого ответа с целевого устройства в файл журнала Ansible. Для работы этого параметра необходимо установить опцию конфигурации Ansible 'log_path' в путь к файлу с правами записи. Необходимо понимать последствия включения этого параметра, так как он может создать уязвимость безопасности, записывая конфиденциальную информацию в файл журнала. |
| port целое число | Значение по умолчанию: 22 | записи ini: [defaults] переменная среды:ANSIBLE_REMOTE_PORT переменная: ansible_port | Указывает порт на удаленном устройстве, который прослушивает подключения при установлении SSH-соединения. |
| private_key_file - | записи ini: [defaults] переменная среды:ANSIBLE_PRIVATE_KEY_FILE переменная: ansible_private_key_file | Файл с закрытым SSH-ключом или сертификатом, используемый для аутентификации на удаленном устройстве при первом установлении SSH-соединения. | |
| remote_user - | записи ini: [defaults] переменная среды:ANSIBLE_REMOTE_USER переменная: ansible_user | Имя пользователя, используемое для аутентификации на удаленном устройстве при первоначальном подключении по SSH. Если remote_user не указан, для подключения будет использован имя пользователя вошедшего пользователя. Можно настроить с помощью командной строки с помощью опций --user или -u. | |
| terminal_inital_prompt_newline логический добавлен в 2.9 | Значение по умолчанию: "да" | переменная: ansible_terminal_initial_prompt_newline | Этот логический флаг, который, при установке в True, отправит перевод строки в ответе, если какое-либо из значений в terminal_initial_prompt будет совпадать. |
| terminal_initial_answer список добавлен в 2.9 | переменная: ansible_terminal_initial_answer | Ответ, который нужно отправить, если совпадет terminal_initial_prompt. Значение может быть одним ответом или списком ответов для нескольких terminal_initial_prompt. В случае, если меню входа имеет несколько приглашений, последовательность приглашения и ожидаемого ответа должна быть в том же порядке, а значение terminal_prompt_checkall должно быть установлено в True, если ожидается совпадение всех значений в terminal_initial_prompt, и в False, если должно быть сопоставлено любое одно приглашение входа. | |
| terminal_initial_prompt список добавлен в 2.9 | переменная: ansible_terminal_initial_prompt | Один шаблон регулярного выражения или последовательность шаблонов для оценки ожидаемого приглашения во время первоначального входа на удаленный хост. | |
| terminal_initial_prompt_checkall логический добавлен в 2.9 | Значение по умолчанию: "нет" | переменная: ansible_terminal_initial_prompt_checkall | По умолчанию значение установлено в False, и если совпадает любое из приглашений, упомянутых в параметре terminal_initial_prompt, другие приглашения не будут проверяться. При установке в True будут проверяться все приглашения, упомянутые в параметре terminal_initial_prompt, в заданном порядке, и все приглашения должны быть получены от удаленного хоста, иначе произойдет превышение времени ожидания. |
| terminal_stderr_re список / элементы=словарь добавлено в 2.9 | переменная: ansible_terminal_stderr_re | Этот параметр предоставляет шаблон регулярного выражения и необязательные флаги для сопоставления строки ошибки из полученного фрагмента ответа. Этот параметр принимает ключи pattern и flags. Значение pattern — это шаблон регулярного выражения Python для сопоставления ответа, а значение flags — это значение, принимаемое аргументом flags метода re.compile языка Python для управления способом сопоставления регулярного выражения с ответом, например 're.I'. | |
| terminal_stdout_re список / элементы=словарь добавлено в 2.9 | переменная: ansible_terminal_stdout_re | Один шаблон регулярного выражения или последовательность шаблонов вместе с необязательными флагами для сопоставления командной строки из полученного фрагмента ответа. Этот параметр принимает ключи pattern и flags. Значение pattern — это шаблон регулярного выражения Python для сопоставления ответа, а значение flags — это значение, принимаемое аргументом flags метода re.compile языка Python для управления способом сопоставления регулярного выражения с ответом, например 're.I'. | |
| timeout целое число | По умолчанию: 120 | Устанавливает время подключения в секундах для связи с удалённым устройством. Этот таймаут используется в качестве значения по умолчанию для таймаута команд при отправке команды сетевому CLI. Если команда не возвращает результат в течение timeout секунд, генерируется ошибка. |
Статус
- Данное соединение не гарантирует обратную совместимость. [preview]
- Это соединение поддерживается сообществом Ansible. [community]
Авторы
- Команда Ansible Networking
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете изменить этот документ, чтобы улучшить его.
Подсказка
Параметры конфигурации для каждого типа записи имеют порядок приоритетов от низкого к высокому. Например, переменная, расположенная ниже в списке, переопределит переменную, расположенную выше.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/plugins/connection/network_cli.html
