network_cli – Использование network_cli для выполнения команд на сетевых устройствах
Новая в версии 2.3.
Описание
- Этот плагин подключения обеспечивает подключение к удалённым устройствам по SSH и реализует оболочку командной строки. Этот плагин подключения обычно используется сетевыми устройствами для отправки и получения команд CLI к сетевым устройствам.
Параметры
| Параметр | Варианты/Значения по умолчанию | Конфигурация | Комментарии |
|---|---|---|---|
| become boolean | Значение по умолчанию: "нет" | Элементы 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 boolean | Значение по умолчанию: "нет" | Элементы ini: [paramiko_connection] переменная окружения:ANSIBLE_HOST_KEY_AUTO_ADD | По умолчанию Ansible запросит пользователя перед добавлением SSH-ключей в файл известных хостов. Поскольку постоянные подключения, такие как network_cli, выполняются в фоновых процессах, пользователь никогда не будет запрошен. Включив эту опцию, неизвестные ключи хостов будут автоматически добавляться в файл известных хостов. Убедитесь, что вы полностью понимаете последствия включения этой опции в производственных системах, так как это может создать уязвимость безопасности. |
| network_os - | переменная: ansible_network_os | Настраивает сетевую операционную систему платформы устройства. Это значение используется для загрузки правильных плагинов терминала и cliconf для связи с удалённым устройством. | |
| password - | переменная: ansible_password переменная: ansible_ssh_pass | Настраивает пароль пользователя, используемый для аутентификации на удалённом устройстве при первом установлении SSH-соединения. | |
| persistent_buffer_read_timeout float | Значение по умолчанию: 0.1 | Элементы ini: [persistent_connection] переменная окружения:ANSIBLE_PERSISTENT_BUFFER_READ_TIMEOUT переменная: ansible_buffer_read_timeout | Настраивает время в секундах ожидания получения данных из канала Paramiko после совпадения приглашения командной строки. Это значение таймаута гарантирует, что приглашение командной строки соответствует и больше данных от удалённого хоста получено не будет. |
| persistent_command_timeout integer | Значение по умолчанию: 10 | Элементы ini: [persistent_connection] переменная окружения:ANSIBLE_PERSISTENT_COMMAND_TIMEOUT переменная: ansible_command_timeout | Настраивает время в секундах ожидания возврата команды с удалённого устройства. Если этот таймер истечёт, прежде чем команда вернётся, плагин подключения сгенерирует исключение и закроет соединение |
| persistent_connect_timeout integer | Значение по умолчанию: 30 | Элементы ini: [persistent_connection] переменная окружения:ANSIBLE_PERSISTENT_CONNECT_TIMEOUT переменная: ansible_connect_timeout | Настраивает время в секундах ожидания при первоначальной попытке установить постоянное соединение. Если это значение истечёт, прежде чем подключение к удалённому устройству будет завершено, подключение завершится неудачей |
| port integer | Значение по умолчанию: 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 integer | Значение по умолчанию: 120 | Устанавливает время соединения в секундах для связи с удалённым устройством. Этот таймаут используется в качестве значения таймаута по умолчанию для команд при вызове команды в сетевой CLI. Если команда не вернётся в течение времени таймаута, будет сгенерирована ошибка. |
Статус
Авторы
- Команда 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.7/plugins/connection/network_cli.html
