network_cli – Используйте network_cli для выполнения команд на сетевых устройствах
Новая версия 2.3.
Описание
- Этот плагин подключения обеспечивает подключение к удалённым устройствам через 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 для обработки повышения привилегий. Обычно значение 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_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. | |
| timeout целое число | По умолчанию: 120 | Устанавливает время подключения (в секундах) для связи с удалённым устройством. Этот тайм-аут используется в качестве значения тайм-аута по умолчанию для команд при выполнении команды в сетевой командной строке. Если команда не возвращает результат в течение timeout секунд, генерируется ошибка. |
Статус
- Данное подключение не гарантирует обратную совместимость. [превью]
- Это подключение поддерживается сообществом Ansible. [community]
Авторы
- Команда Ansible по сетевому администрированию
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
Подсказка
Записи конфигурации для каждого типа записи имеют порядок приоритетов снизу вверх. Например, переменная, расположенная ниже в списке, переопределит переменную, расположенную выше.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/plugins/connection/network_cli.html
