network_cli - Использование network_cli для выполнения команд на сетевых устройствах
Новое в версии 2.3.
Обзор
- Этот плагин подключения обеспечивает подключение к удаленным устройствам через SSH и реализует оболочку командной строки. Этот плагин подключения обычно используется сетевыми устройствами для отправки и получения команд CLI на сетевые устройства.
Параметры
| Параметр | Варианты/Значения по умолчанию | Настройка | Комментарии |
|---|---|---|---|
| become | Значение по умолчанию: нет | Входные данные ini: [ ] [ ] Переменная окружения:ANSIBLE_BECOME Переменная: ansible_become | Параметр become указывает сессии CLI на попытку повышения привилегий на платформах, которые это поддерживают. Обычно это означает переход от пользовательского режима к enable режиму в сессии CLI. Если become установлено в True, а удаленное устройство не поддерживает повышение привилегий или повышение привилегий уже выполнено, то этот параметр игнорируется.Можно настроить из командной строки с помощью опций --become или -b |
| become_method | Значение по умолчанию: sudo | Входные данные ini: [ ] [ ] Переменная окружения:ANSIBLE_BECOME_METHOD Переменная: ansible_become_method | Этот параметр позволяет указать метод become для обработки повышения привилегий. Обычно значение become_method устанавливается в enable, но может быть определено и другими значениями. |
| host | Значение по умолчанию: inventory_hostname | Переменная: ansible_host | Указывает FQDN или IP-адрес удаленного устройства для установления SSH-соединения. |
| host_key_auto_add | Значение по умолчанию: нет | Входные данные ini: [ ] [ ] Переменная окружения:ANSIBLE_HOST_KEY_AUTO_ADD | По умолчанию Ansible запросит пользователя перед добавлением SSH-ключей в файл известных хостов. Поскольку постоянные подключения, такие как network_cli, работают в фоновых процессах, пользователь никогда не будет запрошен. Включив эту опцию, неизвестные ключи хостов будут автоматически добавлены в файл известных хостов. Убедитесь, что вы полностью понимаете последствия включения этой опции в производственных системах, так как это может создать уязвимость в системе безопасности. |
| network_os | Значение по умолчанию: Нет | Переменная: ansible_network_os | Настраивает сетевую операционную систему платформы устройства. Это значение используется для загрузки правильных плагинов терминала и cliconf для связи с удаленным устройством. |
| password | Переменная: ansible_password Переменная: ansible_ssh_pass | Настраивает пароль пользователя, используемый для аутентификации на удаленном устройстве при первоначальном установлении SSH-соединения. | |
| persistent_command_timeout | Значение по умолчанию: 10 | Входные данные ini: [ ] [ ] Переменная окружения:ANSIBLE_PERSISTENT_COMMAND_TIMEOUT | Настраивает время ожидания, в секундах, для возврата команды с удаленного устройства. Если этот таймер истечет до возврата команды, плагин подключения сгенерирует исключение и закроет соединение. |
| persistent_connect_timeout | Значение по умолчанию: 30 | Входные данные ini: [ ] [ ] Переменная окружения:ANSIBLE_PERSISTENT_CONNECT_TIMEOUT | Настраивает время ожидания, в секундах, при попытке первоначального установления постоянного соединения. Если это значение истечет до завершения соединения с удаленным устройством, соединение будет прервано. |
| port | Значение по умолчанию: 22 | Входные данные ini: [defaults ] Переменная окружения:ANSIBLE_REMOTE_PORT Переменная: ansible_port | Указывает порт на удаленном устройстве, который слушает подключения при установлении SSH-соединения. |
| private_key_file | Входные данные ini: [ ] [ ] Переменная окружения: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 по разработке сетевых решений
Подсказка
Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать его, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/plugins/connection/network_cli.html
